Skip to content

Radix Relay

Developer Guide

dustingooding/radix-relay

Developer Guide¶

Welcome to the Radix Relay developer documentation.

Quick Links¶

Contributing - How to contribute to the project
Testing - Test-driven development practices
Coding Standards - Code style and conventions

Development Workflow¶

1. Set Up Environment¶

# Clone repository
git clone https://github.com/dustingooding/radix-relay.git
cd radix-relay

# Create .envrc for your development environment
# See example below
direnv allow

Example `.envrc`¶

Create a .envrc file in the project root with your environment configuration:

# Development environment
export CMAKE_GENERATOR=Ninja

# Python virtual environment
layout python python3
pip install -q -r requirements.txt

# Install pre-commit hooks
pre-commit install

# Rust environment
export PATH="$HOME/.cargo/bin:$PATH"

# LeakSanitizer suppressions for known false positives
export LSAN_OPTIONS="suppressions=lsan.supp"

# Ensure Rust quality tools are installed
if command -v rustup &> /dev/null; then
    rustup component add clippy rustfmt 2>/dev/null || true
fi

The lsan.supp file contains suppressions for known false positives from Slint's Rust runtime, Wayland client libraries, and Rust standard library allocations.

2. Make Changes¶

# Create a feature branch
git checkout -b feature/my-feature

# Make your changes
# Write tests first (TDD)
# Implement feature
# Run tests

3. Test¶

# Run all tests
ctest --preset=test-unixlike-clang-debug

# Run specific test
ctest --preset=test-unixlike-clang-debug -R test_name

4. Submit¶

# Commit with gitmoji prefix
git commit -m ":sparkles: add new feature"

# Push and create PR
git push origin feature/my-feature

Build System¶

Uses modern CMake with:

CMake 3.21+
Preset-based configuration
CPM for dependency management
Corrosion for Rust integration

Code Organization¶

radix-relay/
├── src/              # C++ source files
├── lib/              # Libraries (Signal Protocol bridge)
├── rust/             # Rust components
├── test/             # Tests
└── docs/             # Documentation

Getting Help¶