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.
621 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
Sanaz Taheri Boshrooyeh eebaffdfce
chore(Rln-relay): Tutorial on how to run rln-chat2 in on-chain mode (#1044) 
* initial draft of the tutorial

* WIP: explaining test scenarios

* revises the intro

* sample text output and further instructions and refinement

* renames the prerequisite file

* adds a link to the prerequisite tutorial

* explains how to reuse rln credentials

* adds more revisions on the variable names

* fixes the file name

* revises the intro

* minor rewording

* adds a section header

* makes the waku-rln-relay name consistent in case

* fixes the contract address

* revises the description

* renames client in the sample test

* proof read and spell check

* disambiguates ethereum and goerli accounts

* reorganizes the text

* adds image folder

* adds fig caption and some description

* fixes a wrong case

* removes commented parts

* revises the overview

* more clarification on the spam protection

* addresses editorial comments

* fixes the contract address

* fixes a typo
 		2022-08-04 16:35:16 -07:00
.github Update labels.yml 2022-08-02 16:20:35 +08:00
ci ci: disable Nim compiler colors 2022-07-22 13:45:47 +02:00
docs chore(Rln-relay): Tutorial on how to run rln-chat2 in on-chain mode (#1044) 2022-08-04 16:35:16 -07:00
examples refactor(waku-store): major code reorganization, move StoreQueue to message_store folder 2022-08-01 13:02:40 +02:00
metrics Update default fleet metrics dashboard (#844) 2022-02-08 12:22:06 +01:00
tests Noise: split Noise submodule in smaller submodules (#979) 2022-08-04 10:47:00 +02:00
vendor fix: update dnsclient submodule (#1039) 2022-07-21 12:55:37 +02:00
waku Noise: split Noise submodule in smaller submodules (#979) 2022-08-04 10:47:00 +02: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: ignore Jetbrains IDE configuration files 2022-05-23 20:42:48 +02:00
.gitmodules feat(rest): Add HTTP REST API (#727). Debug API POC 2022-06-14 18:20:15 +02:00
CHANGELOG.md docs: Release v0.10 (#1000) 2022-06-14 22:05:52 +02:00
Dockerfile chore(docker): use NIMFLAGS instead of NIM_PARAMS (#961) 2022-05-17 21:11:07 +02: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(docker): use NIMFLAGS instead of NIM_PARAMS (#961) 2022-05-17 21:11:07 +02:00
README.md docs: added bug reporting section to main readme (#912) 2022-03-28 14:17:50 +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
waku.nimble feat(rest): Add HTTP REST API (#727). Debug API POC 2022-06-14 18:20:15 +02: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.

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.