go-waku

module
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2023 License: MIT

README

go-waku

A Go implementation of the Waku v2 protocol.


Install

Building from source
git clone https://github.com/waku-org/go-waku
cd go-waku
make

# See the available command line options with
./build/waku --help
Nix

You can build Waku v2 node using Nix Flakes:

nix build github:waku-org/go-waku

Or build the library using:

nix build github:waku-org/go-waku#library

To start a shell with build dependencies use:

nix develop
Docker
docker run -i -t -p 60000:60000 -p 9000:9000/udp \
  statusteam/go-waku:latest \ # or, the image:tag of your choice
    --dns-discovery:true \
    --dns-discovery-url:enrtree://AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM@prod.waku.nodes.status.im \
    --discv5-discovery

or build and run the image with:

docker build -t statusteam/go-waku:latest .

docker run statusteam/go-waku:latest --help
Building on windows

Windows requires the following tools to be installed

Library

go get github.com/waku-org/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

or

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

Directories

Path Synopsis
cmd
c
Set of functions that are exported when go-waku is built as a static/dynamic library
Set of functions that are exported when go-waku is built as a static/dynamic library
mobile
Package gowaku implements gomobile bindings for go-waku.
Package gowaku implements gomobile bindings for go-waku.
logging implements custom logging field types for commonly logged values like host ID or wallet address.
logging implements custom logging field types for commonly logged values like host ID or wallet address.
Contains resources or utils for test units
Contains resources or utils for test units
waku
try

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL