Jakub Sokołowski
349e22bbe8
This way we can build node or the library locally using: ```sh nix build nix build .#node nix build .#library ``` Or just start a shell with Go `1.19.x` using: ``` nix develop ``` Which simply has the same environment as the build shell for the node. One known snag is that there is currently no simple way to keep `vendorSha256` updated to match the contents of `go.mod` and `go.sum`. For more details see: https://discourse.nixos.org/t/how-should-i-build-a-go-package-from-local-source/19490/8 One way around this would be to have our own `vendor` folder, but that's also a pretty ugly solution that requires manual updating. Resolves: https://github.com/waku-org/go-waku/issues/256 Signed-off-by: Jakub Sokołowski <jakub@status.im> |
||
|---|---|---|
| .github/workflows | ||
| build | ||
| ci | ||
| cmd/waku | ||
| coverage | ||
| docs | ||
| examples | ||
| hooks | ||
| library | ||
| logging | ||
| mobile | ||
| pkg | ||
| scripts/linux | ||
| tests | ||
| waku | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| .golangci.yaml | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| LICENSE-APACHEv2 | ||
| LICENSE-MIT | ||
| Makefile | ||
| README.md | ||
| VERSION | ||
| flake.lock | ||
| flake.nix | ||
| go.mod | ||
| go.sum | ||
README.md
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 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/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
- Receive and send messages using Waku Relay
- Send messages using Waku Lightpush
- Encrypting and decrypting Waku Messages
- Retrieve message history using Waku Store
- C Bindings
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:
- Go (version 1.17 or later)
- protoc
- Protocol Buffers for Go with Gadgets
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
or
- 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.