Development Guide

This guide covers setting up a development environment for NCN Network v2.

---

Quick Start

# Clone repository
git clone https://github.com/neurochainai/ncn-network-v2-rs.git
cd ncn-network-v2-rs

# Build all components
cargo build

# Run tests
cargo test --all

# Start services for local development
./scripts/start-local.sh

---

Development Guides

Environment Setup

Prerequisites and initial setup:

• Installing Rust, Python, and Git

• IDE configuration

• Development tools

Building

Building from source:

• Full workspace build

• Individual component builds

• Docker image builds

• Troubleshooting build issues

Running Locally

Local development workflow:

• Starting all services

• Development mode configuration

• Hot reloading

• Connecting components

Testing

Test suites and coverage:

• Unit tests

• Integration tests

• Contract tests

• Security tests

• Load testing

Debugging

Debug tips and techniques:

• Logging configuration

• Debug builds

• Profiling

• Common issues

---

Development Workflow

Typical Development Cycle

1. Create feature branch
   git checkout -b feature/my-feature

2. Make changes
   [edit code]

3. Build and test
   cargo build
   cargo test

4. Format and lint
   cargo fmt
   cargo clippy

5. Run locally
   cargo run --bin [component]

6. Commit changes
   git add .
   git commit -m "feat: my feature"

7. Push and create PR
   git push origin feature/my-feature

Code Style

• Follow Rust 2021 edition

• Use cargo fmt for formatting

• Use cargo clippy for linting

• Document public APIs

• Add tests for new features

---

Quick Reference

Build Commands

# Build everything
cargo build

# Build release
cargo build --release

# Build specific component
cargo build -p gateway_node
cargo build -p compute_node
cargo build -p p2p_registry_node

# Build contracts
cd contracts && forge build

Test Commands

# All tests
cargo test --all

# Specific component
cargo test -p gateway_node

# With logging
RUST_LOG=debug cargo test

# Contract tests
cd contracts && forge test -vvv

Run Commands

# P2P Registry
cargo run --bin p2p_registry_node

# Gateway
cargo run --bin gateway_node

# Compute Node
cargo run --bin compute_node -- --gateway-addr http://127.0.0.1:50051

# Test Client
cargo run --bin test_client

Useful Environment Variables

# Logging
export RUST_LOG=debug
export RUST_LOG=gateway_node=trace,compute_node=debug

# Development mode
export REQUIRE_PAYMENT=false
export SANDBOX_MODE=disabled

# Feature flags
export ENABLE_EXECUTION_FALLBACK=true

---

Next Steps

1. Set up your environment

2. Build the project

3. Run locally

4. Run tests