GoLang Miner management with restful control
Find a file
snider b454bbd6d6 feat: Add context propagation, state sync, and tests
- Add context.Context to ManagerInterface methods (StartMiner, StopMiner, UninstallMiner)
- Add WebSocket state sync on client connect (sends current miner states)
- Add EventStateSync event type and SetStateProvider method
- Add manager lifecycle tests (idempotent stop, context cancellation, shutdown timeout)
- Add database tests (initialization, hashrate storage, stats)
- Add EventHub tests (creation, broadcast, client count, state provider)
- Update all test files for new context-aware API

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-31 10:10:39 +00:00
.claude feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
.github/workflows docs: Add MkDocs documentation site with GitHub Pages deployment 2025-12-31 00:25:26 +00:00
.playwright-mcp chore: Remove tracked screenshot (now gitignored) 2025-12-31 07:14:52 +00:00
cmd feat: Add WebSocket events, simulation mode, and redesigned Miners page 2025-12-31 07:11:41 +00:00
docs feat: Add WebSocket events, simulation mode, and redesigned Miners page 2025-12-31 07:11:41 +00:00
miner fix: Update documentation for miner-cuda plugin and improve build instructions 2025-12-31 01:53:53 +00:00
pkg feat: Add context propagation, state sync, and tests 2025-12-31 10:10:39 +00:00
site-docs feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
ui feat: Add WebSocket events, simulation mode, and redesigned Miners page 2025-12-31 07:11:41 +00:00
.coderabbit.yaml Complete Go 1.24 package with CLI, tests, and configuration 2025-11-08 16:52:16 +00:00
.gitignore feat(api): Add structured API error responses with codes and suggestions 2025-12-31 09:38:25 +00:00
.goreleaser.yaml feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
AGENTS.md adds miner-cli, a miner management and lifecycle tool 2025-11-09 01:02:31 +00:00
CLAUDE.md feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
docker-compose.p2p.yml feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
Dockerfile.node feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
go.mod feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
go.sum feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
LICENSE Complete Go 1.24 package with CLI, tests, and configuration 2025-11-08 16:52:16 +00:00
Makefile feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
mkdocs.yml fix: Address CodeRabbit review findings 2025-12-31 01:28:01 +00:00
MKDOCS_SETUP.md docs: Add MkDocs documentation site with GitHub Pages deployment 2025-12-31 00:25:26 +00:00
openapi-3.json adds miner-cli, a miner management and lifecycle tool 2025-11-09 01:02:31 +00:00
qodana.yaml refactor: Remove unused code and fix nil dereference issues 2025-12-31 09:24:12 +00:00
README.md docs: Add documentation badge linking to GitHub Pages 2025-12-31 09:36:14 +00:00

Mining

CI Release Go Version Angular GoDoc Go Report Card codecov License: EUPL-1.2 Platform Docs

A modern, modular cryptocurrency mining management platform with GPU support, RESTful API, and cross-platform desktop application.

Mining Dashboard

Features

Supported Algorithms

Algorithm Coin CPU GPU (OpenCL) GPU (CUDA)
RandomX Monero (XMR)
KawPow Ravencoin (RVN)
ETChash Ethereum Classic (ETC)
ProgPowZ Zano (ZANO)
Blake3 Decred (DCR)
CryptoNight Various

Core Capabilities

  • Multi-Algorithm Mining: Support for CPU and GPU mining across multiple algorithms
  • Dual Mining: Run CPU and GPU mining simultaneously with separate pools
  • Profile Management: Save and switch between mining configurations
  • Real-time Monitoring: Live hashrate, shares, and performance metrics
  • RESTful API: Full control via HTTP endpoints with Swagger documentation
  • Web Dashboard: Embeddable Angular web component for any application
  • Desktop Application: Native cross-platform app built with Wails v3
  • Mobile Responsive: Touch-friendly UI with drawer navigation
  • Simulation Mode: Test the UI without real mining hardware

Why Mining Platform?

Feature Mining Platform NiceHash HiveOS Manual XMRig
Open Source
No Fees (2%+) ($3/mo)
Multi-Algorithm
GUI Dashboard
Profile Management
Dual Mining
Desktop App
Embeddable Component
Self-Hosted
Simulation Mode

Mining Software

Manages installation and configuration of:

  • XMRig - High-performance CPU/GPU miner (RandomX, CryptoNight)
  • T-Rex - NVIDIA GPU miner (KawPow, Ethash, and more)
  • lolMiner - AMD/NVIDIA GPU miner (Ethash, Beam, Equihash)
  • TT-Miner - NVIDIA GPU miner (Ethash, KawPow, Autolykos2)

Quick Start

CLI

# Install
go install github.com/Snider/Mining/cmd/mining@latest

# Start the API server
miner-ctrl serve --host localhost --port 9090

# Or use the interactive shell
miner-ctrl serve

Web Component

<script type="module" src="./mbe-mining-dashboard.js"></script>
<snider-mining api-base-url="http://localhost:9090/api/v1/mining"></snider-mining>

Desktop Application

Download pre-built binaries from Releases or build from source:

cd cmd/desktop/mining-desktop
wails3 build

Architecture

Mining/
├── cmd/
│   ├── mining/              # CLI application
│   └── desktop/             # Wails desktop app
├── pkg/mining/              # Core Go package
│   ├── mining.go            # Interfaces and types
│   ├── manager.go           # Miner lifecycle management
│   ├── service.go           # RESTful API (Gin)
│   ├── xmrig.go             # XMRig implementation
│   └── profile_manager.go   # Profile persistence
├── miner/core/              # Modified XMRig with algorithm support
│   └── src/
│       ├── backend/opencl/  # OpenCL GPU kernels
│       ├── backend/cuda/    # CUDA GPU kernels
│       └── crypto/          # Algorithm implementations
└── ui/                      # Angular 20+ web dashboard
    └── src/app/
        ├── components/      # Reusable UI components
        └── pages/           # Route pages

API Reference

Base path: /api/v1/mining

Method Endpoint Description
GET /info System info and installed miners
GET /miners List running miners
POST /miners/:name Start a miner
DELETE /miners/:name Stop a miner
GET /miners/:name/stats Get miner statistics
GET /profiles List saved profiles
POST /profiles Create a profile
PUT /profiles/:id Update a profile
DELETE /profiles/:id Delete a profile
POST /miners/:name/install Install miner software

Swagger UI: http://localhost:9090/api/v1/mining/swagger/index.html

Development

Prerequisites

  • Go 1.24+
  • Node.js 20+ (for UI development)
  • CMake 3.21+ (for miner core)
  • OpenCL SDK (for GPU support)

Build Commands

# Backend
make build              # Build CLI binary
make test               # Run tests with coverage
make dev                # Start dev server on :9090

# Frontend
cd ui
npm install
npm run build           # Build web component
npm test                # Run unit tests (36 specs)

# Desktop
cd cmd/desktop/mining-desktop
wails3 build            # Build native app

# Miner Core (GPU support)
cd miner/core
mkdir build && cd build
cmake .. -DWITH_OPENCL=ON -DWITH_CUDA=ON
make -j$(nproc)

Configuration

Mining profiles are stored in ~/.config/lethean-desktop/mining_profiles.json

Example profile:

{
  "id": "uuid",
  "name": "My XMR Mining",
  "minerType": "xmrig",
  "config": {
    "pool": "stratum+tcp://pool.supportxmr.com:3333",
    "wallet": "YOUR_WALLET_ADDRESS",
    "algo": "rx/0"
  }
}

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the EUPL-1.2 License - see the LICENSE file for details.

Acknowledgments

  • XMRig - High performance miner
  • Wails - Desktop application framework
  • Angular - Web framework
  • Gin - HTTP web framework
  • Cobra - CLI framework