Refactor RavenChain module and enhance requirements

Add module-level docstring to `__init__.py` and define public API. Update `requirements.txt` to include Uvicorn and SQLAlchemy. Introduce new scripts for database checks and block inspections, and improve block validation logic in `block.py`.

Author: raythurman2386

Dockerfile

@@ -1,10 +1,8 @@
-# Use Python 3.13 slim image as base
-FROM python:3.13-slim
+FROM python:3.13-slim AS base
 
 # Set environment variables
 ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    POETRY_VERSION=1.7.1
+    PYTHONUNBUFFERED=1
 
 # Set working directory
 WORKDIR /app
@@ -14,6 +12,7 @@ RUN apt-get update \
     && apt-get install -y --no-install-recommends \
         gcc \
         python3-dev \
+        curl \
     && rm -rf /var/lib/apt/lists/*
 
 # Copy only requirements first to leverage Docker cache
@@ -28,8 +27,11 @@ COPY . .
 # Install the package in editable mode
 RUN pip install -e .
 
-# Expose port for API (if implementing REST API)
+# API stage
+FROM base AS api
 EXPOSE 8000
+CMD ["uvicorn", "api.main:app", "--host", "0.0.0.0", "--port", "8000", "--workers", "4"]
 
-# Command to run the application
+# Core stage
+FROM base AS core
 CMD ["python", "main.py"]

README.md

@@ -13,13 +13,14 @@ A modern, Python-based blockchain implementation focusing on simplicity, securit
 - ✅ Persistent wallet storage
 - ✅ Chain validation and integrity checking
 - ✅ Mining rewards system
+- ✅ FastAPI-based REST API
+- ✅ Database persistence with PostgreSQL
+- ✅ Docker containerization
 
 ### Planned Features
 - 🔄 Peer-to-peer networking
-- 🌐 FastAPI-based REST API
 - 📊 Block explorer web interface
 - 📜 Smart contract support
-- 💾 Database persistence
 - 🔍 UTXO model implementation
 - 🔒 Enhanced security features
 - ⚡ Performance optimizations
@@ -28,9 +29,9 @@ A modern, Python-based blockchain implementation focusing on simplicity, securit
 
 - **Language**: Python 3.13+
 - **Cryptography**: `ecdsa`, `hashlib`
-- **Storage**: PostgreSQL for block explorer and indexing
+- **Storage**: PostgreSQL for blockchain persistence
 - **Backend**: FastAPI for REST API endpoints
-- **Frontend**: React 19 with TypeScript
+- **Frontend**: React 19 with TypeScript (planned)
 - **Future Stack**:
   - WebSocket for real-time updates
   - Redis for caching
@@ -49,20 +50,21 @@ ravenchain/
 ├── api/                    # FastAPI backend
 │   ├── __init__.py
 │   ├── main.py            # API entry point
-│   ├── routes/            # API routes
-│   └── models/            # Pydantic models
-├── frontend/              # React 19 frontend
-│   ├── src/
-│   ├── public/
-│   ├── package.json
-│   └── tsconfig.json
+│   ├── routes/            # API route handlers
+│   │   ├── block_routes.py
+│   │   ├── mining_routes.py
+│   │   ├── transaction_routes.py
+│   │   └── wallet_routes.py
+│   └── database/          # Database models and config
+│       └── models.py
 ├── config/                # Configuration
-│   └── settings.py        # Global settings
-├── tests/                # Test suite
-├── utils/                # Utility functions
-├── docker-compose.yml    # Docker configuration
-└── README.md            # Documentation
-```
+│   ├── settings.py        # App settings
+│   └── logging.py         # Logging setup
+├── scripts/               # Utility scripts
+├── tests/                 # Test suite
+├── Dockerfile            # Docker build file
+├── docker-compose.yml    # Docker services config
+└── requirements.txt      # Python dependencies
 
 ## 🚀 Quick Start
 
@@ -130,17 +132,17 @@ docker-compose run --rm ravenchain pytest --cov=ravenchain
 - [x] Wallet management system
 - [x] Command-line interface
 - [x] Transaction handling
-- [ ] Unit test coverage
-- [ ] Documentation improvements
+- [x] Unit test coverage
+- [x] Documentation improvements
 
 ### Phase 2: Data Persistence & API (Next)
-- [ ] Implement PostgreSQL for blockchain storage
-- [ ] Design and implement FastAPI REST API
-  - [ ] Block endpoints
-  - [ ] Transaction endpoints
-  - [ ] Wallet endpoints
-  - [ ] Mining endpoints
-- [ ] API documentation with Swagger/OpenAPI
+- [x] Implement PostgreSQL for blockchain storage
+- [x] Design and implement FastAPI REST API
+  - [x] Block endpoints
+  - [x] Transaction endpoints
+  - [x] Wallet endpoints
+  - [x] Mining endpoints
+- [x] API documentation with Swagger/OpenAPI
 - [ ] Request rate limiting
 - [ ] API authentication system
 

docker-compose.yml

@@ -1,6 +1,8 @@
 services:
   ravenchain:
-    build: .
+    build: 
+      context: .
+      target: core
     volumes:
       - .:/app
       - blockchain_data:/app/data
@@ -18,92 +20,58 @@ services:
     stdin_open: true   # Keep STDIN open
     restart: unless-stopped
 
-  # FastAPI Backend (Uncomment when ready)
-  # api:
-  #   build: 
-  #     context: .
-  #     dockerfile: Dockerfile
-  #     target: api  # Using multi-stage build for API
-  #   volumes:
-  #     - .:/app
-  #     - logs:/app/logs
-  #   ports:
-  #     - "8000:8000"
-  #   environment:
-  #     - ENVIRONMENT=development
-  #     - DEBUG=1
-  #     - DATABASE_URL=postgresql://ravenchain:ravenchain@db:5432/ravenchain
-  #     - RAVENCHAIN_LOGS_DIR=/app/logs
-  #     - LOG_LEVEL=DEBUG
-  #     - LOG_JSON=1
-  #     - CORS_ORIGINS=http://localhost:3000  # Allow frontend in dev
-  #     - MAX_WORKERS=4  # Uvicorn workers
-  #   command: uvicorn api.main:app --host 0.0.0.0 --port 8000 --reload --workers 4
-  #   healthcheck:
-  #     test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
-  #     interval: 30s
-  #     timeout: 10s
-  #     retries: 3
-  #   depends_on:
-  #     db:
-  #       condition: service_healthy
-  #     ravenchain:
-  #       condition: service_started
-
-  # React 19 Frontend (Uncomment when ready)
-  # frontend:
-  #   build:
-  #     context: ./frontend
-  #     dockerfile: Dockerfile.frontend
-  #     target: development  # Using multi-stage build for frontend
-  #   volumes:
-  #     - ./frontend:/app
-  #     - /app/node_modules
-  #   ports:
-  #     - "3000:3000"
-  #   environment:
-  #     - NODE_ENV=development
-  #     - VITE_API_URL=http://localhost:8000  # Using Vite for React 19
-  #     - WATCHPACK_POLLING=true  # Better hot reload in Docker
-  #     - VITE_BLOCKCHAIN_WS=ws://localhost:8000/ws  # WebSocket for real-time updates
-  #     - VITE_ENABLE_DEVTOOLS=true  # React DevTools
-  #   command: npm run dev
-  #   healthcheck:
-  #     test: ["CMD", "curl", "-f", "http://localhost:3000"]
-  #     interval: 30s
-  #     timeout: 10s
-  #     retries: 3
-  #   depends_on:
-  #     api:
-  #       condition: service_healthy
+  api:
+    build: 
+      context: .
+      dockerfile: Dockerfile
+      target: api
+    volumes:
+      - .:/app
+      - logs:/app/logs
+    ports:
+      - "8000:8000"
+    environment:
+      - ENVIRONMENT=development
+      - DEBUG=1
+      - RAVENCHAIN_DB_HOST=db
+      - RAVENCHAIN_DB_PORT=5432
+      - RAVENCHAIN_DB_NAME=ravenchain
+      - RAVENCHAIN_DB_USER=postgres
+      - RAVENCHAIN_DB_PASS=admin
+      - RAVENCHAIN_LOGS_DIR=/app/logs
+      - LOG_LEVEL=DEBUG
+      - LOG_JSON=1
+      - CORS_ORIGINS=http://localhost:3000
+      - MAX_WORKERS=4
+    command: uvicorn api.main:app --host 0.0.0.0 --port 8000 --reload --workers 4
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000/api/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+    depends_on:
+      db:
+        condition: service_healthy
+      ravenchain:
+        condition: service_started
 
-  # PostgreSQL 17 Database (Uncomment when ready)
-  # db:
-  #   image: postgres:17-alpine
-  #   volumes:
-  #     - postgres_data:/var/lib/postgresql/data/
-  #     - ./init.sql:/docker-entrypoint-initdb.d/init.sql:ro  # Initial schema
-  #   environment:
-  #     - POSTGRES_USER=ravenchain
-  #     - POSTGRES_PASSWORD=ravenchain
-  #     - POSTGRES_DB=ravenchain
-  #     - PGDATA=/var/lib/postgresql/data/pgdata  # Custom data directory
-  #   ports:
-  #     - "5432:5432"
-  #   healthcheck:
-  #     test: ["CMD-SHELL", "pg_isready -U ravenchain"]
-  #     interval: 5s
-  #     timeout: 5s
-  #     retries: 5
-  #   command: >
-  #     postgres
-  #     -c shared_buffers=256MB
-  #     -c max_connections=200
-  #     -c effective_cache_size=1GB
-  #     -c work_mem=16MB
-  #   shm_size: '256mb'  # Shared memory size for better performance
+  db:
+    image: postgres:17-alpine
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=admin
+      - POSTGRES_DB=ravenchain
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
 
 volumes:
   blockchain_data:
   logs:
-  # postgres_data:  # Uncomment when adding database
+  postgres_data:

ravenchain/__init__.py

@@ -1 +1,8 @@
+"""RavenChain Module."""
 
+from .blockchain import Blockchain
+from .block import Block
+from .transaction import Transaction
+from .wallet import Wallet
+
+__all__ = ["Blockchain", "Block", "Transaction", "Wallet"]

ravenchain/block.py

@@ -9,7 +9,9 @@ def __init__(self, index, timestamp=None, data=None, previous_hash=None):
         """Initialize a block with its attributes"""
         if index is None or index < 0:
             raise ValueError("Block index must be a non-negative integer")
-        if not isinstance(data, list) or not all(isinstance(tx, Transaction) for tx in data):
+        if data is not None and (
+            not isinstance(data, list) or not all(isinstance(tx, Transaction) for tx in data)
+        ):
             raise ValueError("Block data must be a list of Transaction objects")
 
         self.index = index