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.
1,242 Commits 138 Branches 46 Tags 708 MiB
Nim 98.9%
Shell 0.3%
Makefile 0.3%
Groovy 0.2%
Python 0.1%
Other 0.1%
Go to file
Ivan Folgueira Bande 11e7394e0d
Adding 'librln' to `libwaku` and cleaning waku_example.c (#2044) 
* When adding the dependency with 'librln' to 'libwaku', it is required
  to remove the dependency with 'confutils' because the 'nim-confutils'
  module prevents the creation of a dynamic library (libwaku.so.)

* waku_example.c: less code is needed because the Waku Thread attends
  any Waku event whereas the main thread can have a blocking scanf
  to retrieve user inputs.
 		2023-09-19 17:01:32 +02:00
.github chore(postgres): not loading the libpq library by default & better user feedback (#2028) 2023-09-13 12:45:55 +02:00
.sv4git/templates feat: add release-notes target (#1734) 2023-05-18 14:45:45 +02:00
apps feat: HTTP REST API: Filter support v2 (#1890) 2023-09-14 21:28:57 +02:00
ci feat(rln-relay): removed rln from experimental 🚀 (#2001) 2023-09-11 12:02:31 +05:30
docker/binaries Add utils to Dockerfile (#1991) 2023-09-05 15:50:54 +02:00
docs feat(rln-relay): removed rln from experimental 🚀 (#2001) 2023-09-11 12:02:31 +05:30
examples Adding 'librln' to `libwaku` and cleaning waku_example.c (#2044) 2023-09-19 17:01:32 +02:00
library refactor(cbindings): Thread-safe communication between the main thread and the Waku Thread (#1978) 2023-09-18 09:21:50 +02:00
metrics chore(rln-relay): update metrics dashboard (#1745) 2023-05-19 16:24:53 +05:30
migrations chore(migrations): move migration scripts to project root 2022-11-03 17:58:05 +01:00
scripts ci: add jq, fix RLN build script to not use rustup 2023-09-19 16:20:06 +02:00
tests chore(rln-relay): logs, updated submodule, leaves_set metric (#2024) 2023-09-18 10:56:58 +05:30
tools chore(rln-relay): updated docs (#1993) 2023-09-11 11:10:41 +05:30
vendor chore: Updating nim-chronicles, nim-chronos, nim-presto, nimcrypto, nim-libp2p, and nim-nat-transversal (#2043) 2023-09-18 18:51:49 +02:00
waku Adding 'librln' to `libwaku` and cleaning waku_example.c (#2044) 2023-09-19 17:01:32 +02:00
.dockerignore add a Dockerfile for creating nim-waku images 2020-05-27 12:51:20 +02:00
.editorconfig chore: add editorconfig file 2022-11-21 09:31:03 +01:00
.gitignore feat: Rest API interface for legacy (v1) filter service. (#1851) 2023-08-04 11:34:22 +02:00
.gitmodules refactor(cbindings): Thread-safe communication between the main thread and the Waku Thread (#1978) 2023-09-18 09:21:50 +02:00
.sv4git.yml chore(ci): extend and rename nightly workflow to support RC builds (#1784) 2023-06-08 17:13:40 +02:00
CHANGELOG.md chore(release): update changelog for v0.20.0 release (#2026) 2023-09-14 16:03:13 +02:00
Dockerfile ci: add jq, fix RLN build script to not use rustup 2023-09-19 16:20:06 +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 Adding 'librln' to `libwaku` and cleaning waku_example.c (#2044) 2023-09-19 17:01:32 +02:00
README.md docs(README): List possible WSL Issue (#1995) 2023-09-11 18:06:19 +02:00
config.nims chore(ci): properly set os and architecture for nightly and release (#1780) 2023-06-06 17:41:41 +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 feat(rln_db_inspector): create rln_db_inspector tool (#1999) 2023-09-07 18:15:25 +05:30

README.md

Nwaku

Introduction

The nwaku repository implements Waku, and provides tools related to it.

  • A Nim implementation of the Waku (v2) protocol.
  • CLI application wakunode2 that allows you to run a Waku node.
  • Examples of Waku usage.
  • Various tests of above.

For more details see the source code

How to Build & Run

These instructions are generic. For more detailed instructions, see the Waku source code above.

Prerequisites

The standard developer tools, including a C compiler, GNU Make, Bash, and Git. More information on these installations 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 updated.
make wakunode2

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

For more on how to run wakunode2, refer to:

Issues

WSL

If you encounter difficulties building the project on WSL, consider placing the project within WSL's filesystem, avoiding the /mnt/ directory.

Developing

Nim Runtime

This repository is bundled with a Nim runtime that includes the necessary dependencies for the project.

Before you can utilise the runtime you'll need to build the project, as detailed in a previous section. This will generate a vendor directory containing various dependencies, including the nimbus-build-system which has the bundled nim runtime.

After successfully building the project, you may bring the bundled runtime into scope by running:

source env.sh

If everything went well, your should see your prompt suffixed with [Nimbus env]$. Now you can run nim commands as usual.

Waku Protocol Test Suite

# Run all the Waku tests
make test

Examples

Examples can be found in the examples folder. This includes 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 Waku Discord server.