logos-waku-module

How to Build

Using Nix (Recommended)

Build Complete Module (Library + Headers)

# Build everything (default)
nix build

# Or explicitly
nix build '.#default'

The result will include:

• /lib/waku_module_plugin.dylib (or .so on Linux) - The Waku module plugin
• /lib/libwaku.dylib (or .so on Linux) - The Waku library dependency
• /include/waku_module_api.h - Generated header for the module API
• /include/waku_module_api.cpp - Generated implementation for the module API

Build Individual Components

# Build only the library (plugin + libwaku)
nix build '.#logos-waku-module-lib'

# Build only the generated headers
nix build '.#logos-waku-module-include'

Development Shell

# Enter development shell with all dependencies
nix develop

Note: In zsh, you need to quote the target (e.g., '.#default') to prevent glob expansion.

If you don't have flakes enabled globally, add experimental flags:

nix build --extra-experimental-features 'nix-command flakes'

The compiled artifacts can be found at result/

Modular Architecture

The nix build system is organized into modular files in the /nix directory:

• nix/default.nix - Common configuration (dependencies, flags, metadata)
• nix/lib.nix - Module plugin and libwaku library compilation
• nix/include.nix - Header generation using logos-cpp-generator

Output Structure

When built with Nix, the module produces:

result/
├── lib/
│   ├── libwaku.dylib          # Waku network library
│   └── waku_module_plugin.dylib  # Logos module plugin
└── include/
    ├── waku_module_api.h      # Generated API header
    └── waku_module_api.cpp    # Generated API implementation

Both libraries must remain in the same directory, as waku_module_plugin.dylib is configured with @loader_path to find libwaku.dylib relative to itself.

Requirements

Build Tools

• CMake (3.14 or later)
• Ninja build system
• pkg-config

Dependencies

• Qt6 (qtbase)
• Qt6 Remote Objects (qtremoteobjects)
• logos-liblogos
• logos-cpp-sdk (for header generation)
• libwaku (included in lib/)