About this project

# BTX Start Miner BTX Start is a competitive onboarding frontend and installer fork for [BTX](https://btxprice.com), the post-quantum Bitcoin Knots fork with matmul proof-of-work. It simplifies the process of joining the BTX network by providing a streamlined path from installation to earning, handling variance through pooled mining. ## Key Features * **Simplified Onboarding**: Reduces friction with a `curl | bash` installer that detects hardware, verifies binaries, and configures optimal settings automatically. * **Cross-Platform Support**: Supports Linux (NVIDIA Pascal through Blackwell GPUs), Windows (via WSL2), and Apple Silicon (Metal). * **Performance Tuning**: Includes an automated benchmarking tool (`dexbtx-miner benchmark`) to sweep parameters like workers, threads, and batch size for maximum efficiency. * **Robust Error Handling**: Ships with built-in fallbacks for common failure modes such as CUDA buffer exhaustion, silent CPU fallbacks, and peer disconnections. * **Transparent Fees**: Offers a 7-day fee-free trial, followed by a 0.50% platform fee. ## Quick Start ### Linux + NVIDIA GPU Check compatibility without installing: ```bash curl -fsSL https://drinknile.com/install.sh | bash -s -- --preflight --address 'btx1z...YOUR_BTX_ADDRESS...' ``` Install if preflight passes: ```bash curl -fsSL https://drinknile.com/install.sh | bash -s -- --address 'btx1z...YOUR_BTX_ADDRESS...' ``` Start mining: ```bash dexbtx-miner --config ~/.dexbtx-miner/config.yaml ``` ### Apple Silicon Mac Use the Metal backend: ```bash curl -fsSL https://drinknile.com/install.sh | bash -s -- \ --preflight \ --solver-backend metal \ --local-solver "$HOME/.dexbtx-miner/bin/btx-gbt-solve" \ --trust-local-solver \ --address 'btx1z...YOUR_BTX_ADDRESS...' \ --worker 'mac-ultra' ``` ### Windows PC Install Ubuntu via WSL2, ensure NVIDIA drivers are installed in Windows, then run the Linux installer commands inside the Ubuntu terminal. ## Architecture & Tuning The miner uses a Python orchestrator (`dexbtx-miner`) that wraps a native binary solver (`btx-gbt-solve`). The solver supports multiple GPU architectures (Pascal, Turing, Ampere, Ada Lovelace, Hopper, Blackwell) via embedded cubins or PTX JIT compilation. **Recommended Tuning Defaults:** * `workers=16`, `threads=8`, `batch=128` * These settings work across most NVIDIA generations from GTX 10-series to RTX 50-series. To optimize further, use the benchmark tool: ```bash dexbtx-miner benchmark --write-config ``` ## Backend Services The repository includes a scaffold for a first-party backend (`backend/README.md`) which handles: * Stratum server entrypoint. * Stats API and health checks. * Payout processing and billing integration. Note: The stratum server rejects shares until real matmul validation is fully wired in; do not set it live prematurely. ## Contributing Clone the repo and install in editable mode: ```bash git clone https://github.com/pythonoptic-sketch/minebtx-start cd minebtx-start pip install --user -e . dexbtx-miner --config config.example.yaml ``` License: MIT.