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,141 Commits 126 Branches 87 Tags 703 MiB
Nim 99.1%
Shell 0.3%
Makefile 0.2%
Python 0.1%
Groovy 0.1%
Go to file
Ivan Folgueira Bande 1d3410c7bd
fix(libp2p): Updating nim-libp2p to fix the `wss` connectivity issue (#1848) 
* Updating nim-libp2p to fix the `wss` connectivity issue

* The `nim-libp2p` adds many changes although we are actually interested
in the latest commit:

> wstransport.nim: avoid re-raising 'TransportOsError' to avoid stopping
`switch.accept` (#929)

* The `nim-stew` bump is needed so that the `nim-libp2p` can compile.

* The changes in `waku_node.nim` are needed due to the changes in
`nim-stew`.

* waku_node.nim: returning a "completed" future within 'statusAndConfidenceHandler'

  This is aimed to avoid the next exception happening in the wakunode:

  ```
  Unhandled defect: Async procedure (service.nim(74)    callHandler)
  yielded `nil`, are you await'ing a `nil` Future? [AssertionDefect]
  ```

  * Adding 'async' to 'statusAndConfidenceHandler' so that it properly returns a Future[void]
 		2023-07-13 18:00:55 +02:00
.github refactor(archive): Moving waku archive logic from app.nim to the archive module (#1817) 2023-06-27 13:24:31 +02:00
.sv4git/templates feat: add release-notes target (#1734) 2023-05-18 14:45:45 +02:00
apps chore(rln-relay): verify proofs based on bandwidth usage (#1844) 2023-07-07 17:28:37 +05:30
ci fix: sanity-check the docker image start 2023-06-27 19:32:40 +02:00
docs chore(ci): extend and rename nightly workflow to support RC builds (#1784) 2023-06-08 17:13:40 +02:00
examples Refactoring of libwaku to export only C types (#1845) 2023-07-07 10:53:00 +02:00
library Refactoring of libwaku to export only C types (#1845) 2023-07-07 10:53:00 +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 fix(rln-relay): buildscript bad cp (#1636) 2023-03-31 17:15:46 +05:30
tests chore(rln-relay): verify proofs based on bandwidth usage (#1844) 2023-07-07 17:28:37 +05:30
vendor fix(libp2p): Updating nim-libp2p to fix the `wss` connectivity issue (#1848) 2023-07-13 18:00:55 +02:00
waku fix(libp2p): Updating nim-libp2p to fix the `wss` connectivity issue (#1848) 2023-07-13 18:00:55 +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 Refactoring of libwaku to export only C types (#1845) 2023-07-07 10:53:00 +02:00
.gitmodules chore: removed unused submodule (#1580) 2023-02-28 10:35:20 +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 docs(changelog): release notes for v0.18.0 (#1791) 2023-06-13 22:48:53 +02:00
Dockerfile Dockerfile: Adding 'libpq-dev' to the resulting docker image (#1827) 2023-06-27 15:59:17 +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 Refactoring of libwaku to export only C types (#1845) 2023-07-07 10:53:00 +02:00
README.md chore(docs): add docker-compose instructions (#1444) 2022-12-05 16:25:37 +01: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 chore(docs): fix docs and mark some as deprecated (#1754) 2023-05-25 13:37:49 +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

For more on how to run wakunode2, refer to:

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.