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.
821 Commits 149 Branches 46 Tags 1.2 GiB
Nim 98.8%
Shell 0.4%
Makefile 0.2%
Python 0.2%
Groovy 0.2%
Other 0.1%
Go to file
Alvaro Revuelta 7917e05d9d
chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 
* chore(networkmonitor): initial prototype

* chore(networkmonitor): add cli, metrics and PoC

* feat(utils): add supportsCapability function + tests

* feat(utils): add supportedCapabilites function

* chore(networkmonitor): add metrics with enr/ip/capabilities

* chore(networkmonitor): refactor + tests

* chore(networkmonitor): add discovered timestamp

* chore(networkmonitor): add metrics on connected nodes

* chore(networkmonitor): new flags + utils file + readme

* chore(networkmonitor): add user-agent metrics

* chore(networkmonitor): connect only to randomly discovered peers

* chore(networkmonitor): get location of peer using ip

* chore(networkmonitor): expose peer metrics with simple rest server

* chore(networkmonitor): update README

* chore(networkmonitor): fix wakunode2 to waku_node

* chore(networkmonitor): fix import order

* chore(networkmonitor): fix comments + refactor + pushraises

* chore(networkmonitor): refactor + handle exceptions

* chore(networkmonitor): fix makefile after rebase

* chore(networkmonitor): address review comments 1

* chore(networkmonitor): add nim.cfg
 		2022-11-10 10:29:34 +01:00
.github ci: run ci test workflows selectively 2022-10-20 18:44:22 +02:00
apps refactor(rln): remove kilic lib (#1365) 2022-11-09 19:45:04 +01:00
ci ci(jenkins): use MAKEFLAGS and NIMFLAGS pipeline params in build and test stages 2022-10-25 16:58:52 +02:00
docs docs: extend docs with the different node configuration mechanisms 2022-11-08 18:29:40 +01:00
examples chore: rename protocols rpc_codec procs from init to decode 2022-11-07 16:24:16 +01:00
metrics feat(rln-relay): add metrics dashboard (#1275) 2022-10-19 15:08:15 +05:30
migrations chore(migrations): move migration scripts to project root 2022-11-03 17:58:05 +01:00
tests chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 2022-11-10 10:29:34 +01:00
tools chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 2022-11-10 10:29:34 +01:00
vendor fix: replace nim's std/nre with nim-regex library 2022-11-02 15:55:09 +01:00
waku chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 2022-11-10 10:29:34 +01:00
wrappers Refactor wakunode2.nim (#664) 2021-07-14 19:58:46 +02:00
.dockerignore add a Dockerfile for creating nim-waku images 2020-05-27 12:51:20 +02:00
.gitignore chore(rln): update ganache (#1347) 2022-11-08 14:28:11 +01:00
.gitmodules fix: replace nim's std/nre with nim-regex library 2022-11-02 15:55:09 +01:00
CHANGELOG.md docs: release v0.12.0 (#1231) 2022-10-06 17:29:58 +01:00
Dockerfile ci: fix path to migrations in Dockerfile 2022-11-04 13:37:02 +01:00
LICENSE-APACHEv2 Fix name in licence (#517) 2021-04-28 20:00:45 +10:00
LICENSE-MIT Fix name in licence (#517) 2021-04-28 20:00:45 +10:00
Makefile chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 2022-11-10 10:29:34 +01:00
README.md chore(wakucanary): add canary tool (#1205) 2022-10-11 05:58:44 +02:00
config.nims fix: building on Apple clang and M1 (#907) 2022-03-28 15:21:02 +02:00
env.sh Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
shell.nix feat(store): simplify wakunode2 configuration options 2022-10-26 17:10:30 +02:00
waku.nimble chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 2022-11-10 10:29:34 +01: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.
  • Rust

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.

Tools

Different tools and their corresponding how-to guides can be found in the tools folder.

Bugs, Questions & Features

For an inquiry, or if you would like to propose new features, feel free to open a general issue.

For bug reports, please tag your issue with the bug label.

If you believe the reported issue requires critical attention, please use the critical label to assist with triaging.

To get help, or participate in the conversation, join the Vac Discord server.