BlockGuardian represents a cutting-edge financial services platform designed to meet the stringent requirements of modern investment management and regulatory compliance. This comprehensive version incorporates enterprise-grade security, robust compliance frameworks, and professional-quality user interfaces that align with industry best practices for financial technology solutions.

The platform provides a complete ecosystem for portfolio management, trading operations, risk assessment, and regulatory compliance, making it suitable for institutional investors, wealth management firms, and fintech companies seeking to deliver sophisticated financial services to their clients.

• Architecture Overview
• Key Features
• Technology Stack
• Security & Compliance Framework
• Performance Metrics
• Installation & Setup
• API Documentation
• Database Schema
• Testing Strategy
• License

BlockGuardian follows a modern microservices architecture with clear separation of concerns, ensuring scalability, maintainability, and regulatory compliance. The system is structured around four core components:

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │   Backend       │    │   Blockchain    │
│   React App     │◄──►│   Flask API     │◄──►│   Smart         │
│                 │    │                 │    │   Contracts     │
└─────────────────┘    └─────────────────┘    └─────────────────┘
         │                       │                       │
         │                       │                       │
         ▼                       ▼                       ▼
┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   User          │    │   Database      │    │   External      │
│   Interface     │    │   PostgreSQL    │    │   APIs          │
│                 │    │                 │    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘

The platform is built on a foundation of robust financial and regulatory capabilities, summarized in the table below:

BlockGuardian leverages a modern, high-performance technology stack to ensure scalability and reliability.

The platform is engineered with a security-first approach, integrating robust controls across all layers of the application.

BlockGuardian is designed for high performance and scalability, targeting the following metrics:

Before installing BlockGuardian, ensure you have the following prerequisites:

• Python 3.9+ with pip package manager
• Node.js 18+ with npm or yarn
• PostgreSQL 14+ database server
• Redis 7+ for caching and session management
• Docker & Docker Compose (optional, for containerized deployment)

1. Clone the Repository

   git clone https://github.com/quantsingularity/BlockGuardian.git
   cd BlockGuardian/code/backend

2. Create Virtual Environment

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install Dependencies

   pip install -r requirements.txt

4. Environment Configuration

   cp .env.example .env
   # Edit .env file with your configuration

5. Database Setup

   # Create database
   createdb blockguardian
   
   # Run migrations
   python manage.py db upgrade
   
   # Seed initial data
   python manage.py seed

6. Start Backend Server

   python run.py

1. Navigate to Frontend Directory

   cd ../frontend

2. Install Dependencies

   npm install
   # or
   yarn install

3. Environment Configuration

   cp .env.local.example .env.local
   # Edit .env.local with your configuration

4. Start Development Server

   npm run dev
   # or
   yarn dev

For containerized deployment:

# Build and start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop services
docker-compose down

The API is structured around key financial services, providing secure and efficient access to portfolio, trading, and compliance functions.

Detailed request and response schemas are available in the Swagger/OpenAPI 3.0 specification.

The database schema is built on PostgreSQL, ensuring transactional integrity and high availability. The core tables are summarized below, with full SQL definitions provided for reference.

CREATE TABLE users (
    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    email VARCHAR(255) UNIQUE NOT NULL,
    password_hash VARCHAR(255) NOT NULL,
    first_name VARCHAR(100) NOT NULL,
    last_name VARCHAR(100) NOT NULL,
    phone_number VARCHAR(20),
    date_of_birth DATE,
    country VARCHAR(2),
    kyc_status VARCHAR(20) DEFAULT 'pending',
    aml_risk_level VARCHAR(20) DEFAULT 'low',
    is_active BOOLEAN DEFAULT true,
    mfa_enabled BOOLEAN DEFAULT false,
    mfa_secret VARCHAR(255),
    backup_codes TEXT,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    metadata JSONB
);

CREATE TABLE portfolios (
    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    user_id UUID NOT NULL REFERENCES users(id),
    name VARCHAR(255) NOT NULL,
    description TEXT,
    total_value DECIMAL(15,2) DEFAULT 0,
    invested_amount DECIMAL(15,2) DEFAULT 0,
    cash_balance DECIMAL(15,2) DEFAULT 0,
    unrealized_pnl DECIMAL(15,2) DEFAULT 0,
    realized_pnl DECIMAL(15,2) DEFAULT 0,
    risk_level VARCHAR(20) DEFAULT 'moderate',
    benchmark_symbol VARCHAR(10),
    auto_rebalance BOOLEAN DEFAULT false,
    rebalance_threshold DECIMAL(5,4) DEFAULT 0.05,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    asset_allocation JSONB,
    metadata JSONB
);

CREATE TABLE transactions (
    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    user_id UUID NOT NULL REFERENCES users(id),
    portfolio_id UUID REFERENCES portfolios(id),
    transaction_id VARCHAR(50) UNIQUE NOT NULL,
    transaction_type VARCHAR(20) NOT NULL,
    asset_symbol VARCHAR(20),
    asset_name VARCHAR(255),
    quantity DECIMAL(15,8),
    price DECIMAL(15,2),
    total_amount DECIMAL(15,2) NOT NULL,
    fees DECIMAL(15,2) DEFAULT 0,
    currency VARCHAR(3) DEFAULT 'USD',
    status VARCHAR(20) DEFAULT 'pending',
    settlement_date DATE,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    metadata JSONB
);

A rigorous testing strategy is employed across the entire platform to ensure code quality, security, and compliance.

BlockGuardian is licensed under the MIT License. See the LICENSE file for details.