snider 69376b886f feat: Rebrand xmrig to miner and vendor XMRig ecosystem

Complete rebranding of all components:
- Core miner: xmrig -> miner (binary, version.h, CMakeLists.txt)
- Proxy: xmrig-proxy -> miner-proxy
- CUDA plugin: xmrig-cuda -> miner-cuda
- Heatmap: xmrig-nonces-heatmap -> miner-nonces-heatmap
- Go CLI wrapper: miner-cli -> miner-ctrl

Vendored XMRig ecosystem into miner/ directory:
- miner/core - XMRig CPU/GPU miner
- miner/proxy - Stratum proxy
- miner/cuda - NVIDIA CUDA plugin
- miner/heatmap - Nonce visualization tool
- miner/config - Configuration UI
- miner/deps - Pre-built dependencies

Updated dev fee to use project wallet with opt-out (kMinimumDonateLevel=0)
Updated branding to Lethean (domain, copyright, version 0.1.0)

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2025-12-30 19:43:02 +00:00

2.4 KiB

Raw Blame History

Mining API Documentation

The Mining project provides a comprehensive RESTful API for managing cryptocurrency miners. This API is served by the miner-ctrl serve command.

Swagger Documentation

The project includes automatically generated Swagger (OpenAPI) documentation.

When you run the service (e.g., miner-ctrl serve), the Swagger UI is available at:

http://<host>:<port>/api/v1/mining/swagger/index.html

(Default: http://localhost:8080/api/v1/mining/swagger/index.html)

You can also find the raw Swagger files in this directory:

API Endpoints Summary

All endpoints are prefixed with /api/v1/mining (or the configured --namespace).

System & Health

Method	Endpoint	Description
`GET`	`/info`	Retrieves cached installation details for all miners and system info.
`POST`	`/doctor`	Performs a live check on all available miners to verify installation status.
`POST`	`/update`	Checks if any installed miners have a new version available.

Miner Management

Method	Endpoint	Description
`GET`	`/miners`	List all currently running miners.
`GET`	`/miners/available`	List all miner types supported by the system.
`POST`	`/miners/:miner_type`	Start a new miner instance. Requires a JSON config body.
`DELETE`	`/miners/:miner_name`	Stop a running miner instance.
`POST`	`/miners/:miner_type/install`	Install or update a specific miner binary.
`DELETE`	`/miners/:miner_type/uninstall`	Uninstall a specific miner and remove its files.
`GET`	`/miners/:miner_name/stats`	Get real-time statistics (hashrate, shares, etc.) for a running miner.
`GET`	`/miners/:miner_name/hashrate-history`	Get historical hashrate data.

Data Models

SystemInfo

Contains OS, Architecture, Go Version, total RAM, and a list of installed miners.

Miner Configuration (Config)

A comprehensive object containing settings for the miner, such as:

pool: Mining pool address.
wallet: Wallet address.
cpuPriority: CPU priority settings.
threads: Number of threads to use.
algo: Algorithm to mine.

PerformanceMetrics

Real-time stats from the miner:

hashrate: Current hashrate in H/s.
shares: Total shares submitted.
rejected: Rejected shares.
uptime: Time since start in seconds.

2.4 KiB Raw Blame History