Building

Complete guide for building NCN Network components from source.

---

Quick Build

# Build all components (debug)
cargo build

# Build all components (release)
cargo build --release

---

Build Individual Components

Gateway Node

cargo build -p gateway_node
cargo build --release -p gateway_node

# Binary location
./target/debug/gateway_node
./target/release/gateway_node

Compute Node

cargo build -p compute_node
cargo build --release -p compute_node

# Binary location
./target/debug/compute_node
./target/release/compute_node

P2P Registry Node

cargo build -p p2p_registry_node
cargo build --release -p p2p_registry_node

# Binary location
./target/debug/p2p_registry_node
./target/release/p2p_registry_node

Test Client

cargo build -p test_client
cargo build --release -p test_client

# Binary location
./target/debug/test_client
./target/release/test_client

Common Types Library

cargo build -p common_types

---

Build Features

Gateway Features

# With all features
cargo build -p gateway_node --all-features

# Specific features
cargo build -p gateway_node --features "metrics"

Compute Node Features

# Without sandbox (for development)
cargo build -p compute_node --no-default-features

# With full sandbox
cargo build -p compute_node --features "sandbox"

---

Build Profiles

Debug Build

cargo build

• Includes debug symbols

• No optimizations

• Faster compilation

• Larger binaries

• Better for debugging

Release Build

cargo build --release

• Optimized for performance

• Smaller binaries

• Slower compilation

• Better for production

Custom Profile

# Cargo.toml - already configured
[profile.release]
opt-level = 3
lto = true
codegen-units = 1

---

Cross-Compilation

Linux Target from macOS

# Add target
rustup target add x86_64-unknown-linux-gnu

# Build
cargo build --target x86_64-unknown-linux-gnu --release

ARM64 Target

# Add target
rustup target add aarch64-unknown-linux-gnu

# Build
cargo build --target aarch64-unknown-linux-gnu --release

---

Build Smart Contracts

cd contracts

# Install dependencies
forge install

# Build contracts
forge build

# Output location
ls -la out/

Contract Artifacts

out/
├── InferencePayment.sol/
│   └── InferencePayment.json
├── NCNToken.sol/
│   └── NCNToken.json
└── NCNValidatorRegistry.sol/
    └── NCNValidatorRegistry.json

---

Build Docker Images

All Images

docker-compose build

Individual Images

# Gateway
docker build -t ncn-gateway -f gateway_node/Dockerfile .

# Compute
docker build -t ncn-compute -f compute_node/Dockerfile .

# Registry
docker build -t ncn-registry -f p2p_registry_node/Dockerfile .

# Test Client
docker build -t ncn-test-client -f test_client/Dockerfile .

Multi-stage Build

Docker images use multi-stage builds for smaller images:

# Build stage
FROM rust:1.75 as builder
WORKDIR /app
COPY . .
RUN cargo build --release

# Runtime stage
FROM debian:bookworm-slim
COPY --from=builder /app/target/release/gateway_node /usr/local/bin/
CMD ["gateway_node"]

---

Protocol Buffer Generation

Protobuf code is auto-generated during build via build.rs:

# Regenerate if proto changes
cargo clean -p common_types
cargo build -p common_types

# Generated code location
target/debug/build/common_types-*/out/

Manual Generation

# If needed manually
protoc --rust_out=src/generated \
  --tonic_out=src/generated \
  proto/common_types.proto

---

Build Verification

Check Build

# Verify binaries exist
ls -la target/release/gateway_node
ls -la target/release/compute_node
ls -la target/release/p2p_registry_node
ls -la target/release/test_client

# Check binary version (if implemented)
./target/release/gateway_node --version

Run Tests

# All tests
cargo test --all

# Specific package tests
cargo test -p gateway_node
cargo test -p compute_node

# With logging
RUST_LOG=debug cargo test --all -- --nocapture

Lint Check

# Clippy
cargo clippy --all -- -D warnings

# Format
cargo fmt --all -- --check

---

Build Troubleshooting

Out of Memory

# Reduce parallelism
cargo build -j 2

# Or build one package at a time
cargo build -p common_types
cargo build -p gateway_node

Slow Builds

# Use sccache
cargo install sccache
export RUSTC_WRAPPER=sccache

# Or use mold linker (Linux)
sudo apt install mold
export RUSTFLAGS="-C link-arg=-fuse-ld=mold"

Dependency Conflicts

# Clean and rebuild
cargo clean
cargo build

# Update dependencies
cargo update
cargo build

Protobuf Errors

# Ensure protoc is installed
protoc --version

# Regenerate
cargo clean -p common_types
cargo build

---

Build Artifacts

Binary Locations

Component	Debug	Release
Gateway	target/debug/gateway_node	target/release/gateway_node
Compute	target/debug/compute_node	target/release/compute_node
Registry	target/debug/p2p_registry_node	target/release/p2p_registry_node
Test Client	target/debug/test_client	target/release/test_client

Binary Sizes (Release)

Binary	Approximate Size
gateway_node	~25 MB
compute_node	~20 MB
p2p_registry_node	~18 MB
test_client	~15 MB

---

Next Steps

• Running Locally - Start the services

• Testing - Run the test suite

• Docker Deployment - Deploy with containers