BSV Fee Delegator & UTXO Fanout Platform

A robust, production-grade Bitcoin SV (BSV) backend platform for scalable fee delegation, advanced UTXO fanout generation, and automated wallet operations. Built with Node.js, Docker, Redis, and Kubernetes, it offers modular services and high-performance APIs for modern blockchain applications.

Key Features

• Unified Fee Delegation & UTXO Fanout
  Seamlessly submit BSV transactions without managing fees; automate mass UTXO creation and distribution.
• HD Wallet Management
  Secure, BIP32-based wallet pools with backup, recovery, and high-throughput address rotation.
• Production-Ready DevOps
  Kubernetes deployment, Redis caching, auto-scaling, and advanced rate limiting.
• Extensive API & Metrics
  RESTful endpoints for all operations, with OpenAPI/Swagger docs and Prometheus metrics.
• Real-time Updates
  WebSocket integration for live transaction and UTXO updates.
• User Authentication
  JWT-based authentication system with secure session management.

Default Admin Credentials

The system automatically creates a default admin user on first startup:

• Username: admin
• Password: admin123
• Role: admin
• Email: admin@bsv-platform.com

⚠️ Important: Change the default admin password after first login in production environments.

Tech Stack

Backend

• Node.js with Express.js
• Redis for caching and session management
• WebSocket for real-time communication
• BSV blockchain integration
• WhatsOnChain API integration
• JWT authentication
• Prometheus metrics

Frontend

• React with Fusion theme
• WebSocket client for real-time updates
• Modern UI components
• Responsive design

DevOps

• Docker containerization
• Kubernetes deployment
• Auto-scaling capabilities
• Advanced rate limiting

Project Structure

├── backend/                 # Node.js backend server
│   ├── src/
│   │   ├── controllers/     # API controllers
│   │   ├── services/        # Business logic services
│   │   ├── models/          # Data models
│   │   ├── middleware/      # Express middleware
│   │   ├── routes/          # API routes
│   │   ├── utils/           # Utility functions
│   │   └── websocket/       # WebSocket handlers
│   ├── config/              # Configuration files
│   ├── tests/               # Test files
│   └── package.json
├── frontend/                # React frontend
│   ├── src/
│   │   ├── components/      # React components
│   │   ├── pages/           # Page components
│   │   ├── services/        # API services
│   │   ├── hooks/           # Custom React hooks
│   │   ├── utils/           # Utility functions
│   │   └── styles/          # CSS/styling files
│   └── package.json
├── docker/                  # Docker configurations
├── k8s/                     # Kubernetes manifests
└── docs/                    # Documentation

Quick Start

Prerequisites

• Node.js 18+
• Redis server
• Docker (optional)
• Kubernetes cluster (for production)

Development Setup

1. Clone repository

   git clone <repository-url>
   cd bsv-fee-delegator-platform

2. Backend Setup

   cd backend
   npm install
   cp .env.example .env
   # Configure your environment variables
   npm run dev

3. Frontend Setup

   cd frontend
   npm install
   npm start

4. Redis Setup

   # Using Docker
   docker run -d -p 6379:6379 redis:alpine
   
   # Or install locally
   # Follow Redis installation guide for your OS

Environment Variables

Create a .env file in the backend directory:

NODE_ENV=development
PORT=3001
REDIS_URL=redis://localhost:6379
JWT_SECRET=your-super-secret-jwt-key
BSV_NETWORK=mainnet
WHATSONCHAIN_API_KEY=your-api-key

API Documentation

Once the server is running, visit http://localhost:3001/api-docs for interactive API documentation.

Features

Fee Delegation

• Automatic fee calculation and payment
• Support for multiple fee payment methods
• Transaction broadcasting with fee delegation

UTXO Fanout

• Mass UTXO creation and distribution
• Configurable fanout patterns
• Batch processing capabilities

HD Wallet Management

• BIP32 hierarchical deterministic wallets
• Secure key generation and storage
• Address rotation and management

Real-time Updates

• WebSocket connections for live data
• Transaction status updates
• UTXO change notifications

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

License

MIT License - see LICENSE file for details