Go implementation of Waku v2 protocol

Go to file

Richard Ramos 7b3c853c15 refactor: use diff logger for waku		2022-05-06 15:29:31 -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
docs	chore: add docs for waku store	2022-05-06 10:38:15 -04:00
examples	refactor: use diff logger for waku	2022-05-06 15:29:31 -04:00
hooks	feat: add git hook	2021-10-18 14:43:48 +02:00
library	fix: library docs	2022-05-06 14:13:10 -04:00
mobile	fix: add topic to broadcast and some comments to functions (#229 )	2022-04-25 23:31:26 +04:00
tests	fix: add topic to broadcast and some comments to functions (#229 )	2022-04-25 23:31:26 +04:00
waku	refactor: use diff logger for waku	2022-05-06 15:29:31 -04:00
.dockerignore	Dockerfile: add commit, log format, and make target (#83 )	2021-10-15 12:47:23 +02:00
.gitignore	feat: swift example	2022-05-05 16:51:43 -04:00
CHANGELOG.md	Initial commit	2021-03-11 16:27:12 -04:00
Dockerfile	refactor: use diff logger for waku	2022-05-06 15:29:31 -04: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	feat: swift example	2022-05-05 16:51:43 -04:00
README.md	chore: add instructions to build mobile libs	2022-05-06 14:18:12 -04:00
go.mod	feat: swift example	2022-05-05 16:51:43 -04:00
go.sum	feat: swift example	2022-05-05 16:51:43 -04:00
waku.go	fix: flag names (#233 )	2022-05-04 17:42:28 -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

Mobile libraries

Requires gomobile

make mobile-android
make mobile-ios

Tutorials and documentation

Examples

Examples of usage of go-waku as a library can be found in the examples/ folder:

basic2 - demonstrates how to send and receive messages
chat2 - simple chat client using waku relay / lightpush + filter / store protocol to send/receive messages and retrieve message history
filter2 - demonstrates how to use filter protocol
c-bindings - simple program to demonstrate how to consume the go-waku library via C FFI
waku-csharp - C# console application that uses the go-waku library via FFI
android-kotlin - android app that uses a .jar generated by gomobile using kotlin

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.