waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Waku node and protocol.
210 Commits 102 Branches 68 Tags 696 MiB
Nim 99.3%
Makefile 0.2%
Shell 0.2%
Groovy 0.1%
Go to file
Oskar Thorén 9518322198
Folder restructure (#274) 
* Change folder structure to {v1,v2,common}/...

Addresses https://github.com/status-im/nim-waku/issues/261

* Update waku.nimble paths

* Flatten paths

* Fix import paths

* Pull out utils folder for nat

* Pull out waku_types to top level for v2

* Fix test import paths

* Remove old READMEs and replace with one liner

* Update README and split v1 and v2

* Skeleton READMEs

* Update README.md

Co-authored-by: Kim De Mey <kim.demey@gmail.com>

* Update README.md

Co-authored-by: Kim De Mey <kim.demey@gmail.com>

Co-authored-by: Kim De Mey <kim.demey@gmail.com>
 		2020-11-17 17:34:53 +08:00
.github/workflows Update setup-msys2 to v2 and increase max windows CI time to 90 mins 2020-10-07 15:57:01 +02:00
docs feature/persistence-simple (#268) 2020-11-16 09:38:52 +01:00
examples Folder restructure (#274) 2020-11-17 17:34:53 +08:00
metrics Use metrics with labels, fix #24 (#27) 2020-06-09 13:44:39 +02:00
tests Folder restructure (#274) 2020-11-17 17:34:53 +08:00
vendor feature/persistence-simple (#268) 2020-11-16 09:38:52 +01:00
waku Folder restructure (#274) 2020-11-17 17:34:53 +08:00
.dockerignore add a Dockerfile for creating nim-waku images 2020-05-27 12:51:20 +02:00
.gitignore fix/remove-ds (#249) 2020-11-02 12:11:31 +08:00
.gitmodules feature/persistence-simple (#268) 2020-11-16 09:38:52 +01:00
Dockerfile Update Dockerfile 2020-11-04 16:21:17 +01:00
LICENSE-APACHEv2 Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
LICENSE-MIT Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
Makefile Wakuv1v2 process (#238) 2020-10-21 17:54:29 +08:00
README.md Folder restructure (#274) 2020-11-17 17:34:53 +08:00
config.nims bump vendor/nimbus-build-system (#36) 2020-07-01 09:43:23 +02:00
env.sh Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
waku.nimble Folder restructure (#274) 2020-11-17 17:34:53 +08:00

README.md

nim-waku

Introduction

The nim-waku repository implements Waku v1 and v2, and provides tools related to it.

  • A Nim implementation of the Waku v1 protocol.
  • A Nim implementation of the Waku v2 protocol.
  • CLI applications wakunode and wakunode2 that allows you to run a Waku v1 or v2 node.
  • Examples of Waku v1 and v2 usage.
  • Various tests of above.

For more details on Waku v1 and v2, see their respective home folders:

How to Build & Run

These instructions are generic and apply to both Waku v1 and v2. For more detailed instructions, see Waku v1 and v2 home above.

Prerequisites

  • GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer.
  • PCRE

More information on the installation of these can be found here.

Wakunode

# The first `make` invocation will update all Git submodules.
# You'll run `make update` after each `git pull`, in the future, to keep those submodules up to date.
make wakunode1 wakunode2

# See available command line options
./build/wakunode --help
./build/wakunode2 --help

# Connect the client directly with the Status test fleet
./build/wakunode --log-level:debug --discovery:off --fleet:test --log-metrics
# TODO Equivalent for v2

Waku Protocol Test Suite

# Run all the Waku v1 and v2 tests
make test

Examples

Examples can be found in the examples folder. For Waku v2, there is a fully featured chat example.