Parse and verify the fixed-order .afw container, add the CV1835 board module and an SSH transport with the stock update-daemon root stage, a read-only preflight, a held p1 backup, whole-partition read-back, live verification and network restore. Add the headless afw CLI and offline fixtures for good, tampered, wrong-board, truncated, traversal and oversize bundles. Co-Authored-By: DeepSeek Harness <noreply@deepseek.com>
5.1 KiB
Alkane Toolkit
The badges link to the project site: the manual, the code-quality dashboard (how the grade is set, coverage by crate and file) and the benchmark history.
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through a patched wx-rs bridge. In-app image flashing is disabled while that path is reworked.
Run locally
scripts/build-wx-linux.sh
scripts/build-gui-linux.sh
ALKANE_FAKE_SCAN=1 ~/.cache/alkane-tk-target/release/alkane-toolkit
The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan uses offline fixtures and does not contact hardware.
Windows 10/11 builds are cross-compiled on Linux (scripts/build-wx-windows.sh,
then scripts/build-gui-windows.sh) and attached to every release as a
self-contained alkane-toolkit.exe; see docs/windows.md.
macOS builds run on a Mac (scripts/build-wx-macos.sh, then
scripts/build-gui-macos.sh) and produce one universal app for Apple Silicon
and Intel, macOS 11 or later; see docs/macos.md.
Current scope
- Discover miners by CIDR or IP range with vendored asic-rs.
- Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
- Filter and sort the desktop table; inspect probes with
miner_probe. - Use controls supported by the selected firmware and restore supported aftermarket firmware to stock.
Discovery is read-only. Control and restore actions change miners. Check the selected devices before applying them.
Headless .afw install (CV1835)
alkane-cli is the headless engine; the GUI uses the same engine. A verified
.afw is a full OS bundle for exactly one board. The CV1835 installer writes
only /dev/mmcblk0p1 over SSH, holds the current p1 first, reads the whole
partition back, and reboots only after the read-back matches.
alkane-cli afw verify BUNDLE.afw --allow-unsigned
alkane-cli afw plan BUNDLE.afw --host 10.255.1.167
alkane-cli afw preflight BUNDLE.afw --host 10.255.1.167
alkane-cli afw install BUNDLE.afw --host 10.255.1.167 --dry-run
alkane-cli afw install BUNDLE.afw --host 10.255.1.167 --confirm FLASH
alkane-cli afw verify-live BUNDLE.afw --host 10.255.1.167
alkane-cli afw restore --host 10.255.1.167 --held-backup p1.img --confirm FLASH
On stock Bitmain CV1835 the SSH login is the unprivileged miner account; the
toolkit obtains root through the stock update-daemon loopback channel, not a
serial console. Credentials come only from ALKANE_BOARD_PASSWORD or
ALKANE_BOARD_PASSWORD_FILE, or from --password-file / --identity-file.
No credential value is printed. --allow-unsigned is bench-only; site use
needs an Ed25519-signed bundle.
Development
WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config" \
CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" \
cargo test -p alkane-gui --offline
Keep build output off the source share. main runs full CI and publishes
qualifying releases; next builds -rc candidates. Badges measure host
code, not installation support. See the
benchmark history.
Firmware safety
Installation must follow the SDK install rules: use the exact board's packer and boot-switch procedure, verify through an independent channel, and never write bootloader or secure regions.
License
MIT. Vendored dependencies keep their own terms.