waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nwaku/README.md

72 lines
2.6 KiB
Markdown
Raw Normal View History

Initial commit
2020-04-28 05:06:49 +00:00
# nim-waku
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
## Introduction
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
The nim-waku repository implements Waku v1 and v2, and provides tools related to it.
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
- A Nim implementation of the [Waku v1 protocol](https://specs.vac.dev/waku/waku.html).
- A Nim implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html).
- 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.
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
For more details on Waku v1 and v2, see their respective home folders:
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
- [Waku v1](waku/v1/README.md)
- [Waku v2](waku/v2/README.md)
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
## 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
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
* GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer.
Rust is needed to compile the project (#520)
2021-04-29 06:04:50 +00:00
* [Rust](https://www.rust-lang.org/)
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
More information on the installation of these can be found [here](https://github.com/status-im/nimbus#prerequisites).
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 09:34:53 +00:00
### Wakunode
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
```bash
# 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.
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 09:34:53 +00:00
make wakunode1 wakunode2
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
# See available command line options
./build/wakunode --help
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 09:34:53 +00:00
./build/wakunode2 --help
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
```
chore(docs): add docker-compose instructions (#1444) * chore(docs): add docker-compose instructions * Update docs/operators/quickstart.md Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com> * Update docs/operators/quickstart.md Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com> Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
2022-12-05 15:25:37 +00:00
For more on how to run `wakunode2`, refer to:
* [Run using binaries](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-1-run-nwaku-binary)
* [Run using docker](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-2-run-nwaku-in-a-docker-container)
* [Run using docker-compose](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-3-run-nwaku-with-docker-compose)
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 09:34:53 +00:00
### Waku Protocol Test Suite
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
```bash
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 09:34:53 +00:00
# Run all the Waku v1 and v2 tests
make test
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
```
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 09:34:53 +00:00
### Examples
Move and update Readme.md (#9)
2020-05-08 20:39:16 +00:00
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 09:34:53 +00:00
Examples can be found in the examples folder. For Waku v2, there is a fully
featured chat example.
docs: added bug reporting section to main readme (#912)
2022-03-28 12:17:50 +00:00
chore(wakucanary): add canary tool (#1205) * chore(wakucanary): create folder structure * chore(wakucanary): spawn waku node * chore(wakucanary): get supported protocols from lp2p * chore(wakucanary): add timeout + refactor * chore(wakucanary): fix comments v1 * chore(wakucanary): update readme * chore(wakucanary): static->relay, abbr, logLevel, filter issue, colon * chore(wakucanary): fix typos
2022-10-11 03:58:44 +00:00
### Tools
Different tools and their corresponding how-to guides can be found in the `tools` folder.
docs: added bug reporting section to main readme (#912)
2022-03-28 12:17:50 +00:00
### Bugs, Questions & Features
For an inquiry, or if you would like to propose new features, feel free to [open a general issue](https://github.com/status-im/nim-waku/issues/new/).
For bug reports, please [tag your issue with the `bug` label](https://github.com/status-im/nim-waku/issues/new/).
If you believe the reported issue requires critical attention, please [use the `critical` label](https://github.com/status-im/nim-waku/issues/new?labels=critical,bug) to assist with triaging.
To get help, or participate in the conversation, join the [Vac Discord](https://discord.gg/KNj3ctuZvZ) server.