2.4 KiB
| title |
|---|
| Build Nwaku from Source |
This guide provides detailed steps to build a nwaku node from the source to access the latest development version or a specific commit of nwaku. If you prefer a more stable version, download a pre-compiled binary instead.
:::info Nwaku can be built and run on Linux and macOS, while Windows support is currently experimental. :::
Prerequisites
- 2GB of RAM
- Git or GitHub Desktop
- Nim installed on your system
Install Dependencies
To clone and build nwaku, you will need the standard developer tools, including a C compiler, Make, Bash, and Git.
Linux
To install the dependencies on common Linux distributions, run the following:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
sudo apt-get install build-essential git
dnf install @development-tools
# using your favorite AUR helper
[AUR HELPER] -S base-devel
macOS
If you use Homebrew to manage packages, run the following:
brew install cmake
Clone the Repository
Get the source code from the GitHub repository. The default branch is master, the release candidate for major updates.
git clone https://github.com/waku-org/nwaku
cd nwaku
:::tip
You can use git tag -l to check specific version tags.
:::
Build the Binary
To build the nwaku binary, run the following:
make wakunode2
The first make invocation updates to all Git submodules. After each git pull, run make update to keep the submodules updated in the future.
make update wakunode2
Run the Binary
Nwaku will create the wakunode2 binary in the ./build/ directory.
./build/wakunode2
To learn more about running nwaku, please refer to:
Run Test Suite
To run the tests for both Waku v1 and Waku v2, run the following:
make test