# Alkane OS [![CI](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/main.svg)](https://gitea.bluefla.re/blueflare/alkane-os/actions) ![tests](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/tests.svg) ![coverage](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/coverage.svg) ![bench](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/bench.svg) ![bench coverage](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/bench-coverage.svg) ![lines of code](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/loc.svg) ![dependencies](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/dependencies.svg) ![code quality](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/quality.svg) ![license](https://gitea.bluefla.re/blueflare/alkane-os/raw/branch/ci-badges/badges/license.svg) Rust mining and tuning core for Alkane control boards. The [SDK](https://gitea.bluefla.re/blueflare/alkane-sdk) builds board images and provides the hardware backend. The on-board web console is the parameterised `flare-ui`: a sidebar shell with live telemetry (readings) and real controls (mode/target, start/stop) that drive the runtime, with `/api/...` as the interface of record behind every page. ## Status The host miner supports BM1362 and BM1366 through the SDK's simulator HAL and Stratum V1. Tests have replayed 33 captured BM1366 shares and one BM1362 share to a loopback pool with matching ACCEPT responses. Production board control is still under development. The BM1370 module encodes a captured S21 Pro job and parses captured nonce frames. Work-ID mapping, chain control, and pool acceptance remain open. The HAL client requests PSU shutdown on sensor faults and reserves work IDs until a confirmed reset or shutdown. A production backend still needs a power lease, watchdog, and validated temperature limits. SHA-256d and Litecoin Scrypt proof verification are implemented; Scrypt chip report handling and mining remain open. Run `alkane-os --list-targets` for the target matrix. Set `POOL_PASSWORD` to the pool password, then mine with a simulator HAL socket and Stratum V1 pool: ```sh ALKANE_POOL_PASSWORD="$POOL_PASSWORD" alkane-os --mine-simulator HAL_SOCKET POOL_ADDRESS WORKER BM1366 ``` Use `BM1362` for that chip. Set `ALKANE_API_LISTEN=127.0.0.1:4028` for read-only `summary` and `version` commands; reach it remotely through SSH. To bring up the full web console on a workstation with no hashboard, run `alkane-os --serve-sim`: a reference HAL runs in-process, the runtime boots against it, and the printed URL serves the live, controllable console (the frequency moves toward the target; start/stop and mode changes take effect). `alkane-os --serve` serves the same console with no backend, for a board whose HAL backend is not written yet. `ALKANE_WEB_LISTEN=ADDR` overrides the bind (default port 80, or 8080 without privilege). ## Release gate `main` runs tests, benchmarks, and conformance before release; `next` builds release candidates. The release gate is red. It requires all 64 same-vendor pairings (52 Bitmain, 12 WhatsMiner), unmodified stock firmware, captured silicon nonces, difficulty-1 pool acceptance, and bench-validated models. Stock firmware may faithfully reject a pairing; Alkane OS must mine it. See the [evidence contract](ci/CONFORMANCE.md). Badges cover host code, not board conformance. See the public [benchmark history](https://blueflare.gitea.bluefla.re/alkane-benchmarks/os/). ## Local checks ```sh CARGO_TARGET_DIR=/var/tmp/alkane-os-target cargo test --locked ``` Use an executable target directory if the source mount is `noexec`. ## License [MIT](LICENSE). Vendored dependencies keep their own licenses.