Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1323dc1571 | ||
|
|
848a78ed5f | ||
|
|
8d092ae417 | ||
|
|
7445b05e57 | ||
|
|
faae4ee145 | ||
|
|
942801ee4b | ||
|
|
8de1bdffd4 | ||
|
|
77237023e3 | ||
|
|
fc573f075a | ||
|
|
1c364d4ff1 | ||
|
|
d54bd6473f | ||
|
|
a5b07d22ae | ||
|
|
3d17326460 | ||
|
|
56339a5eca | ||
|
|
00bb760451 | ||
|
|
5f472435a7 | ||
|
|
f22fe19a4d | ||
|
|
8ab83edc73 | ||
|
|
601da0548b | ||
|
|
4592b927ad | ||
|
|
5e347315e2 | ||
|
|
603c49a395 | ||
|
|
bc8e0535d1 | ||
|
|
cf1eaebae1 | ||
|
|
f89f220f3e | ||
|
|
c18a37eebc | ||
|
|
d3a06d682f | ||
|
|
4d530721dc | ||
|
|
0b691ca943 | ||
|
|
ed0f781851 | ||
|
|
613132035a | ||
|
|
b3dc5a336e | ||
|
|
a4d0cb65f0 | ||
|
|
29b9b17c67 | ||
|
|
8deecf3558 | ||
|
|
3a6a190ce1 | ||
|
|
1f0a4cbe76 | ||
|
|
fbc43216fb | ||
|
|
a4fcb6e763 | ||
|
|
76409b0d3b | ||
|
|
4aec6d40ad | ||
|
|
33a116d9fd | ||
|
|
45d9632590 | ||
|
|
0265370be2 | ||
|
|
fadd851e04 | ||
|
|
24f9d9682d | ||
|
|
3f9fc4a24b | ||
|
|
8ab607de6c | ||
|
|
a60bb34e64 | ||
|
|
c944897807 | ||
|
|
a6e22581d7 | ||
|
|
b15de7f747 | ||
|
|
f887affd6d | ||
|
|
e5e6b0f1e1 | ||
|
|
ad28dab542 | ||
|
|
42e3bf8f5b | ||
|
|
4154a50ed0 | ||
|
|
0ab822940e | ||
|
|
c1aa6db834 | ||
|
|
7feab6117b | ||
|
|
808fd4de1d | ||
|
|
63ada5bb99 | ||
|
|
52b7c3f2a1 | ||
|
|
571c2305aa | ||
|
|
79ecc100d3 | ||
|
|
51b4eb2556 | ||
|
|
3b18219e4e | ||
|
|
bcc0ba38b6 | ||
|
|
749cdc4eed | ||
|
|
19e469ebc4 | ||
|
|
6cd732dec5 | ||
|
|
95b8428c12 | ||
|
|
a7ed34b8e4 | ||
|
|
b839e9012d | ||
|
|
d378a484d6 | ||
|
|
64e084ddee | ||
|
|
93bd528430 | ||
|
|
e45e6eaf91 | ||
|
|
e5a6cc2b5e | ||
|
|
6fb73c9746 | ||
|
|
49985631d4 | ||
|
|
8fe61ec427 | ||
|
|
34a1a1f3b1 | ||
|
|
0db89d6c55 | ||
|
|
08b3d56864 | ||
|
|
4e825f3ee5 | ||
|
|
8e67c50fe0 | ||
|
|
da0d1582be | ||
|
|
7f802c568f | ||
|
|
86338062a5 | ||
|
|
c4c85d5b3d | ||
|
|
25c8ccf1ff | ||
|
|
307539543d | ||
|
|
561c50e5dc | ||
|
|
74b97162f5 | ||
|
|
75663f4c23 | ||
|
|
9eb6a0f229 | ||
|
|
bafbd519bb | ||
|
|
0d19e958f0 | ||
|
|
368f992404 | ||
|
|
ecdb2fab9d | ||
|
|
a75fe5ba52 | ||
|
|
f1fb2f8623 | ||
|
|
a6d286a147 | ||
|
|
3ba3211371 | ||
|
|
c8d5cd71c4 | ||
|
|
c74e8ebaca | ||
|
|
282f0b195c | ||
|
|
1857a9e1a0 | ||
|
|
b7a77cbed8 | ||
|
|
606ae85781 | ||
|
|
ad9b0dc868 | ||
|
|
aaf049bbfc | ||
|
|
8b7b0c70b4 | ||
|
|
3ae80efdde | ||
|
|
7901d82c4b | ||
|
|
8f7aab3f80 | ||
|
|
e593548746 | ||
|
|
2fd433c3b0 | ||
|
|
5399f9fc49 | ||
|
|
6b4961d7bc | ||
|
|
fc7c665166 | ||
|
|
ae437c0d24 | ||
|
|
b343746718 | ||
|
|
aa75031112 | ||
|
|
8eb9a2caad | ||
|
|
9e2b453eb5 | ||
|
|
3530d67a5c | ||
|
|
3ac4e104a0 | ||
|
|
3c99934513 | ||
|
|
9b5d811b1e | ||
|
|
77399bdd06 | ||
|
|
408b7d12b4 | ||
|
|
50cd463bee | ||
|
|
d73299166e | ||
|
|
a81fef3c7d | ||
|
|
365732b5d4 | ||
|
|
98603077e3 | ||
|
|
bc9f847689 | ||
|
|
71cdf2d988 | ||
|
|
4fea3becf6 | ||
|
|
7781ff71d3 | ||
|
|
86e4761316 | ||
|
|
c1234f6df7 | ||
|
|
b6afe08a5f | ||
|
|
eb08a9ef97 | ||
|
|
297e21a519 | ||
|
|
7fac0ce726 |
@@ -0,0 +1,20 @@
|
||||
# cargo-audit configuration (read by `cargo audit` from the project root).
|
||||
#
|
||||
# The two entries below are accepted, documented exceptions -- both live only in
|
||||
# the wx-rs BUILD-dependency tree (reqwest 0.11, used by wx-rs's build.rs to
|
||||
# download the wxWidgets source on Windows/macOS). On Linux download_dist()
|
||||
# returns before ever constructing an HTTP client, and none of this is linked
|
||||
# into the runtime binary, which talks to miners over asic-rs's reqwest 0.13
|
||||
# (hyper 1.x / h2 0.4). The build tree is fully vendored and offline, so these
|
||||
# cannot be upgraded without re-vendoring a newer reqwest.
|
||||
#
|
||||
# Re-review whenever the vendored dependency set is refreshed.
|
||||
|
||||
[advisories]
|
||||
ignore = [
|
||||
# h2 0.3 unbounded empty DATA frames (DoS). Build-time only; our build-time
|
||||
# HTTP client only fetches a fixed HTTPS URL, and only on Windows/macOS.
|
||||
"RUSTSEC-2026-0258",
|
||||
# rustls-pemfile 1.0.4 unmaintained. Same build-only reqwest 0.11 subtree.
|
||||
"RUSTSEC-2025-0134",
|
||||
]
|
||||
@@ -0,0 +1,34 @@
|
||||
name: public-benchmark-pages
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '*/15 * * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-public-benchmark-pages
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: alkane-pages
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install SSH client
|
||||
run: |
|
||||
apt-get update -qq
|
||||
apt-get install -y -qq --no-install-recommends openssh-client
|
||||
- name: Render measured benchmark history
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/bench_history.py render
|
||||
- name: Publish public benchmark page
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
BENCH_PAGES_DEPLOY_KEY: ${{ secrets.BENCH_PAGES_DEPLOY_KEY }}
|
||||
run: python3 ci/publish-bench-pages.py toolkit
|
||||
- name: Clean generated page
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
@@ -0,0 +1,19 @@
|
||||
name: completed-ci-badge
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: [build-test-release, next-build]
|
||||
types: [completed]
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: alkane-ci
|
||||
permissions:
|
||||
actions: read
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Publish last completed attempt
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/last-attempt-badge.py
|
||||
@@ -0,0 +1,56 @@
|
||||
name: next-build
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [next]
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-next
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
candidate:
|
||||
runs-on: alkane-ci
|
||||
env:
|
||||
CARGO_TARGET_DIR: target
|
||||
WX_PREFIX: /root/.cache/wx-3.3.3-linux
|
||||
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Install build dependencies
|
||||
run: |
|
||||
apt-get update -qq
|
||||
apt-get install -y -qq --no-install-recommends libssl-dev pkg-config ca-certificates
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
|
||||
- name: Build wxWidgets
|
||||
run: |
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
bash scripts/build-wx-linux.sh
|
||||
fi
|
||||
- name: Build release candidate
|
||||
run: cargo build --release -p alkane-gui -p alkane-artifacts -p alkane-flash -p alkane-cli --offline
|
||||
- name: Select candidate version
|
||||
id: version
|
||||
run: bash ci/compute-rc-version.sh >> "$GITHUB_OUTPUT"
|
||||
- name: Package candidate
|
||||
if: steps.version.outputs.release == 'true'
|
||||
run: |
|
||||
mkdir -p dist
|
||||
cp target/release/alkane-toolkit dist/
|
||||
tar -C dist -czf "dist/alkane-toolkit-${{ steps.version.outputs.version }}-linux-x86_64.tar.gz" alkane-toolkit
|
||||
- name: Create private prerelease
|
||||
if: steps.version.outputs.release == 'true'
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/release-rc.py "${{ steps.version.outputs.tag }}" true "dist/alkane-toolkit-${{ steps.version.outputs.version }}-linux-x86_64.tar.gz"
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
@@ -6,11 +6,23 @@ on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-main
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
actions: write
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: alkane-ci
|
||||
env:
|
||||
CARGO_TARGET_DIR: target
|
||||
WX_PREFIX: /root/.cache/wx-3.3.3-linux
|
||||
# Set once for the whole job so build/clippy/test/bench steps don't each
|
||||
# re-export it (round 18 #12).
|
||||
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
|
||||
steps:
|
||||
- name: Checkout (full history for tags)
|
||||
uses: actions/checkout@v4
|
||||
@@ -22,11 +34,18 @@ jobs:
|
||||
run: bash ci/compute-version.sh | tee -a "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Test version logic
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: bash ci/test-compute-version.sh
|
||||
|
||||
- name: Last-attempt badge checks
|
||||
run: python3 ci/test-last-attempt-badge.py
|
||||
|
||||
- name: Benchmark history checks
|
||||
run: python3 ci/test-bench-history.py
|
||||
|
||||
- name: Benchmark suite checks
|
||||
run: python3 ci/test-bench-badge.py
|
||||
|
||||
- name: Install build dependencies
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
apt-get update -qq
|
||||
apt-get install -y -qq --no-install-recommends \
|
||||
@@ -34,14 +53,12 @@ jobs:
|
||||
echo "libssl-dev + pkg-config installed (openssl-sys needs them)"
|
||||
|
||||
- name: Cache vendored wxWidgets build
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
|
||||
|
||||
- name: Build wxWidgets (once, then cached)
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
bash scripts/build-wx-linux.sh
|
||||
@@ -49,6 +66,12 @@ jobs:
|
||||
echo "wx prefix restored from cache"
|
||||
fi
|
||||
|
||||
- name: Clippy (our crate, warnings are errors)
|
||||
run: |
|
||||
rustup component add clippy >/dev/null 2>&1 || true
|
||||
cargo clippy -p alkane-gui --no-deps --release --bins --offline -- -D warnings
|
||||
cargo clippy -p alkane-artifacts -p alkane-flash -p alkane-cli --all-targets --offline -- -D warnings
|
||||
|
||||
- name: Set crate version to ${{ steps.ver.outputs.version }}
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
@@ -56,32 +79,107 @@ jobs:
|
||||
grep -m1 '^version' Cargo.toml
|
||||
|
||||
- name: Build release
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
export WX_RS_WXCONFIG="$WX_PREFIX/bin/wx-config"
|
||||
cargo build --release -p alkane-gui --offline
|
||||
|
||||
- name: Unit tests
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
export WX_RS_WXCONFIG="$WX_PREFIX/bin/wx-config"
|
||||
cargo test -p alkane-gui --offline
|
||||
set -o pipefail
|
||||
cargo test -p alkane-gui --offline 2>&1 | tee tests-gui.txt
|
||||
cargo test -p alkane-artifacts -p alkane-flash -p alkane-cli --offline 2>&1 | tee tests-core.txt
|
||||
cat tests-gui.txt tests-core.txt > tests-current.txt
|
||||
|
||||
- name: Load previous main benchmark measurement
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/bench_history.py prepare
|
||||
|
||||
- name: Microbenchmarks
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
export WX_RS_WXCONFIG="$WX_PREFIX/bin/wx-config"
|
||||
cargo test -p alkane-gui --release --offline -- --ignored --nocapture bench_
|
||||
# Require every declared benchmark before publishing history or a release.
|
||||
set -o pipefail
|
||||
cargo test -p alkane-gui -p alkane-artifacts --release --offline -- --ignored --nocapture bench_ --test-threads=1 \
|
||||
| tee bench-current.txt
|
||||
python3 ci/bench-badge.py --current bench-current.txt \
|
||||
--baseline badges/bench-baseline.json --no-write
|
||||
|
||||
- name: Record private benchmark history
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/bench_history.py publish
|
||||
|
||||
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@81f940d004763f986ba3582c007fd842dd5cb0d7
|
||||
with:
|
||||
name: alkane-toolkit-benchmark-site-preview
|
||||
path: bench-site/index.html
|
||||
- name: Headless UI self-test
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
apt-get update -qq && apt-get install -y -qq --no-install-recommends \
|
||||
xvfb xauth dbus-x11 fonts-dejavu-core >/dev/null
|
||||
BIN=target/release/alkane-toolkit
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
|
||||
|
||||
- name: Dependency audit (best-effort)
|
||||
continue-on-error: true
|
||||
run: |
|
||||
if command -v cargo-audit >/dev/null 2>&1; then
|
||||
cargo audit || echo "cargo audit reported findings (accepted ones in .cargo/audit.toml)"
|
||||
else
|
||||
echo "cargo-audit not installed on this runner; skipping"
|
||||
fi
|
||||
|
||||
# Merge coverage from unit tests and the headless UI self-test. A failed
|
||||
# measurement must not publish a stale badge or create a release.
|
||||
- name: Coverage
|
||||
id: cov
|
||||
run: |
|
||||
set -euo pipefail
|
||||
rustup component add llvm-tools-preview >/dev/null 2>&1 || true
|
||||
if ! command -v cargo-llvm-cov >/dev/null 2>&1; then
|
||||
V=0.8.7
|
||||
URL="https://github.com/taiki-e/cargo-llvm-cov/releases/download/v${V}/cargo-llvm-cov-x86_64-unknown-linux-gnu.tar.gz"
|
||||
DEST="${CARGO_HOME:-$HOME/.cargo}/bin"
|
||||
mkdir -p "$DEST"
|
||||
curl -fsSL "$URL" | tar -xz -C "$DEST"
|
||||
export PATH="$DEST:$PATH"
|
||||
fi
|
||||
command -v cargo-llvm-cov >/dev/null
|
||||
PCT=$(bash ci/coverage.sh --summary-only \
|
||||
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
|
||||
[ -n "$PCT" ] || { echo "coverage report produced no TOTAL line" >&2; exit 1; }
|
||||
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
|
||||
echo "line coverage (tests + self-test): ${PCT}%"
|
||||
|
||||
- name: Microbenchmark coverage
|
||||
id: benchcov
|
||||
run: |
|
||||
set -euo pipefail
|
||||
command -v cargo-llvm-cov >/dev/null
|
||||
PCT=$(bash ci/bench-coverage.sh --summary-only \
|
||||
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
|
||||
[ -n "$PCT" ] || { echo "microbenchmark coverage unavailable" >&2; exit 1; }
|
||||
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
|
||||
echo "microbenchmark line coverage: ${PCT}%"
|
||||
|
||||
- name: Generate measured badges
|
||||
run: |
|
||||
set -euo pipefail
|
||||
PASS=$(grep -E '^test result: ' tests-current.txt \
|
||||
| grep -oE '[0-9]+ passed' | grep -oE '[0-9]+' \
|
||||
| awk '{s+=$1} END{print s+0}')
|
||||
[ "$PASS" -gt 0 ] || { echo "no passing tests counted" >&2; exit 1; }
|
||||
BENCH_DELTA=$(python3 ci/bench-badge.py --current bench-current.txt \
|
||||
--baseline badges/bench-baseline.json --no-write)
|
||||
python3 ci/gen-badges.py --tests "$PASS" \
|
||||
--coverage "${{ steps.cov.outputs.pct }}" \
|
||||
--bench-coverage "${{ steps.benchcov.outputs.pct }}" \
|
||||
--bench-delta "$BENCH_DELTA" --clippy clean
|
||||
|
||||
- name: Publish measured badges
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/publish-metrics.py
|
||||
|
||||
- name: Package artifact
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
id: pkg
|
||||
@@ -106,22 +204,12 @@ jobs:
|
||||
- name: Create Gitea release + upload artifact
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
env:
|
||||
TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
TAG="${{ steps.ver.outputs.tag }}"
|
||||
API="${GITHUB_API_URL:-https://gitea.bluefla.re/api/v1}"
|
||||
REPO="${GITHUB_REPOSITORY}"
|
||||
body="Automated ${{ steps.ver.outputs.bump }} release from ${GITHUB_SHA}."
|
||||
rel=$(curl -sS -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" \
|
||||
"${API}/repos/${REPO}/releases" \
|
||||
-d "{\"tag_name\":\"${TAG}\",\"target_commitish\":\"${GITHUB_SHA}\",\"name\":\"${TAG}\",\"body\":\"${body}\"}")
|
||||
id=$(echo "$rel" | grep -oE '"id":[0-9]+' | head -1 | cut -d: -f2)
|
||||
if [ -z "$id" ]; then echo "release create failed: $rel"; exit 1; fi
|
||||
curl -sS -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/gzip" \
|
||||
"${API}/repos/${REPO}/releases/${id}/assets?name=${{ steps.pkg.outputs.assetname }}" \
|
||||
--data-binary @"${{ steps.pkg.outputs.asset }}" | grep -oE '"browser_download_url":"[^"]+"' || true
|
||||
echo "Released ${TAG}"
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/release-rc.py "${{ steps.ver.outputs.tag }}" false "${{ steps.pkg.outputs.asset }}"
|
||||
|
||||
- name: No release needed
|
||||
if: steps.ver.outputs.release != 'true'
|
||||
run: echo "No backend/UI change since ${{ steps.ver.outputs.last_tag }} - skipping release."
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
name: verify
|
||||
|
||||
# Pre-merge quality gate: clippy + build + tests + microbenchmarks + the headless
|
||||
# UI self-test, plus a best-effort dependency audit. Runs on pull requests and on
|
||||
# pushes to any branch EXCEPT main (main is gated by release.yml, which repeats
|
||||
# these checks before it cuts a release -- so no work is duplicated on main).
|
||||
on:
|
||||
pull_request:
|
||||
branches-ignore: [next]
|
||||
push:
|
||||
branches-ignore: [main, next]
|
||||
|
||||
jobs:
|
||||
verify:
|
||||
runs-on: alkane-ci
|
||||
env:
|
||||
CARGO_TARGET_DIR: target
|
||||
WX_PREFIX: /root/.cache/wx-3.3.3-linux
|
||||
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install build dependencies
|
||||
run: |
|
||||
apt-get update -qq
|
||||
apt-get install -y -qq --no-install-recommends \
|
||||
libssl-dev pkg-config ca-certificates >/dev/null
|
||||
|
||||
- name: Cache vendored wxWidgets build
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
|
||||
|
||||
- name: Build wxWidgets (once, then cached)
|
||||
run: |
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
bash scripts/build-wx-linux.sh
|
||||
else
|
||||
echo "wx prefix restored from cache"
|
||||
fi
|
||||
|
||||
- name: Clippy (our crate, warnings are errors)
|
||||
run: |
|
||||
rustup component add clippy >/dev/null 2>&1 || true
|
||||
cargo clippy -p alkane-gui --no-deps --release --bins --offline -- -D warnings
|
||||
cargo clippy -p alkane-artifacts -p alkane-flash -p alkane-cli --all-targets --offline -- -D warnings
|
||||
|
||||
- name: Build
|
||||
run: cargo build --release -p alkane-gui --offline
|
||||
|
||||
- name: Unit tests
|
||||
run: |
|
||||
cargo test -p alkane-gui --offline
|
||||
cargo test -p alkane-artifacts -p alkane-flash -p alkane-cli --offline
|
||||
|
||||
- name: Microbenchmarks
|
||||
run: cargo test -p alkane-gui -p alkane-artifacts --release --offline -- --ignored --nocapture bench_ --test-threads=1
|
||||
|
||||
- name: Headless UI self-test
|
||||
run: |
|
||||
apt-get update -qq && apt-get install -y -qq --no-install-recommends \
|
||||
xvfb xauth dbus-x11 fonts-dejavu-core >/dev/null
|
||||
BIN=target/release/alkane-toolkit
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
|
||||
|
||||
# Advisory audit is best-effort: it needs the RustSec DB over the network,
|
||||
# which the vendored/offline build otherwise never touches, so a locked-down
|
||||
# runner must not fail the gate on it. Accepted advisories live in
|
||||
# .cargo/audit.toml.
|
||||
- name: Dependency audit (best-effort)
|
||||
continue-on-error: true
|
||||
run: |
|
||||
if command -v cargo-audit >/dev/null 2>&1; then
|
||||
cargo audit || echo "cargo audit reported findings (see .cargo/audit.toml for accepted ones)"
|
||||
else
|
||||
echo "cargo-audit not installed on this runner; skipping"
|
||||
fi
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
@@ -1,3 +1,4 @@
|
||||
/target
|
||||
**/target
|
||||
.claude/
|
||||
__pycache__/
|
||||
|
||||
@@ -40,12 +40,15 @@ name = "alkane-artifacts"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alkane-core",
|
||||
"sha2",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "alkane-cli"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alkane-artifacts",
|
||||
"alkane-core",
|
||||
]
|
||||
|
||||
@@ -69,17 +72,30 @@ dependencies = [
|
||||
name = "alkane-flash"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alkane-artifacts",
|
||||
"alkane-core",
|
||||
"sha2",
|
||||
"tempfile",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "alkane-gui"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"aes",
|
||||
"alkane-core",
|
||||
"alkane-discovery",
|
||||
"asic-rs",
|
||||
"base64 0.21.7",
|
||||
"ecb",
|
||||
"futures-util",
|
||||
"hex",
|
||||
"md5crypt",
|
||||
"measurements",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"sha2",
|
||||
"tokio",
|
||||
"wx-rs",
|
||||
]
|
||||
|
||||
@@ -13,9 +13,21 @@ members = [
|
||||
[workspace.package]
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
license = "MIT OR Apache-2.0"
|
||||
license = "MIT"
|
||||
|
||||
[workspace.dependencies]
|
||||
thiserror = "2"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
sha2 = "0.10"
|
||||
|
||||
# Release binary: small, self-contained, and fast enough for a fleet GUI whose
|
||||
# hot path is network I/O, not CPU (round 18 #12). opt-level "s" + fat LTO +
|
||||
# one codegen unit + symbol stripping cut the binary substantially. panic stays
|
||||
# "unwind" on purpose: the scan runs many miners on tokio tasks and the wx event
|
||||
# dispatch relies on unwinding so one miner's panic never aborts the whole app.
|
||||
[profile.release]
|
||||
opt-level = "s"
|
||||
lto = "fat"
|
||||
codegen-units = 1
|
||||
strip = true
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Blueflare
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,38 +1,60 @@
|
||||
# alkane-toolkit
|
||||
# Alkane Toolkit
|
||||
|
||||
Cross-platform desktop toolkit (Rust core, native GUI) to install **stock** or
|
||||
**alkaneOS** firmware on ASIC miner control boards, whatever they currently run
|
||||
(stock, Vnish/AnthillOS, Braiins OS+, LuxOS, ePIC, BixBit, WardenOS).
|
||||
[](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
Sibling to [alkane-sdk](https://gitea.bluefla.re/blueflare/alkane-sdk): the SDK
|
||||
owns board knowledge and build outputs; this toolkit is the orchestration
|
||||
engine and operator UI that executes its install recipes safely.
|
||||
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through
|
||||
a patched [wx-rs bridge](thirdparty/wx-rs). Firmware installation is under
|
||||
development.
|
||||
|
||||
## Status
|
||||
|
||||
M1 primary view ships: discovery (vendored asic-rs 0.8.1) + the UI-SPEC
|
||||
table (6 KPIs, sortable/drag-reorderable columns, row checkboxes, scan-range
|
||||
editor, Excel-style filter, columns panel). Pure-Rust GUI on wxWidgets via
|
||||
vendored + patched wx-rs (docs/adr/0002, 0003).
|
||||
|
||||
## Build + run (Debian)
|
||||
## Run locally
|
||||
|
||||
```sh
|
||||
scripts/build-wx-linux.sh # once: builds vendored wx 3.3.3 to ~/.cache
|
||||
scripts/build-gui-linux.sh # cargo build --release -p alkane-gui
|
||||
~/.cache/alkane-tk-target/release/alkane-toolkit
|
||||
scripts/build-wx-linux.sh
|
||||
scripts/build-gui-linux.sh
|
||||
ALKANE_FAKE_SCAN=1 ~/.cache/alkane-tk-target/release/alkane-toolkit
|
||||
```
|
||||
|
||||
Windows/macOS: `scripts/build-gui-windows.sh` (needs a Windows/msys2
|
||||
toolchain) and `scripts/build-gui-macos.sh` (needs a Mac) - the GUI code is
|
||||
shared; only the C++ bridge + wx differ per platform.
|
||||
The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan
|
||||
uses offline fixtures and does not contact hardware. For Windows and macOS,
|
||||
use the matching `scripts/build-gui-*.sh` script.
|
||||
|
||||
See `docs/IMPLEMENTATION-PLAN.md` for the roadmap.
|
||||
## Current scope
|
||||
|
||||
## Hard rules (from alkane-sdk `docs/install-methods.md`, encoded in code)
|
||||
- Discover miners by CIDR or IP range with vendored [asic-rs](vendor/asic-rs).
|
||||
- Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
|
||||
- Filter and sort the desktop table; inspect probes with `miner_probe`.
|
||||
|
||||
1. Never write the bootloader/secure region.
|
||||
2. Verify on a channel the installer does not control.
|
||||
3. Reboot is root-only; a dropped SSH connection can be success.
|
||||
4. A packer is per board; never reuse across boards.
|
||||
5. Boot-switch handling is an explicit, verified step.
|
||||
Discovery is read-only. The installer and operator actions remain in the
|
||||
[implementation plan](docs/IMPLEMENTATION-PLAN.md) and
|
||||
[firmware matrix](docs/aftermarket-parity-roadmap.md).
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
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 public
|
||||
[benchmark history](https://blueflare.gitea.bluefla.re/alkane-benchmarks/toolkit/).
|
||||
|
||||
## Firmware safety
|
||||
|
||||
Installation must follow the [SDK install rules](https://gitea.bluefla.re/blueflare/alkane-sdk/src/branch/main/docs/install-methods.md):
|
||||
use the exact board's packer and boot-switch procedure, verify through an
|
||||
independent channel, and never write bootloader or secure regions.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE). Vendored dependencies keep their own terms.
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"bench_parse_line_near_max_addrs": 807160.0,
|
||||
"bench_parse_targets_many_ranges_near_cap": 54465485.0,
|
||||
"bench_render_cells": 3503112.0,
|
||||
"bench_sort_by_each_column": 486975.0,
|
||||
"bench_targets_to_cidrs_large_range": 482167.0,
|
||||
"bench_upsert_cold_start_population": 8315814.0,
|
||||
"bench_view_pipeline": 191794.0,
|
||||
"bench_view_pipeline_default_sort": 193214.0,
|
||||
"bench_view_pipeline_with_filter": 253085.0
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="128.0" height="20" role="img" aria-label="bench coverage: 7%">
|
||||
<title>bench coverage: 7%</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="128.0" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="103.0" height="20" fill="#555"/>
|
||||
<rect x="103.0" width="25.0" height="20" fill="#e05d44"/>
|
||||
<rect width="128.0" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="51.5" y="15" fill="#010101" fill-opacity=".3">bench coverage</text>
|
||||
<text x="51.5" y="14">bench coverage</text>
|
||||
<text x="115.5" y="15" fill="#010101" fill-opacity=".3">7%</text>
|
||||
<text x="115.5" y="14">7%</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 946 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="bench: +7.4% vs prev">
|
||||
<title>bench: +7.4% vs prev</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="141.0" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="44.5" height="20" fill="#555"/>
|
||||
<rect x="44.5" width="96.5" height="20" fill="#dfb317"/>
|
||||
<rect width="141.0" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="22.2" y="15" fill="#010101" fill-opacity=".3">bench</text>
|
||||
<text x="22.2" y="14">bench</text>
|
||||
<text x="92.8" y="15" fill="#010101" fill-opacity=".3">+7.4% vs prev</text>
|
||||
<text x="92.8" y="14">+7.4% vs prev</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 950 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="95.5" height="20" role="img" aria-label="coverage: 44%">
|
||||
<title>coverage: 44%</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="95.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="64.0" height="20" fill="#555"/>
|
||||
<rect x="64.0" width="31.5" height="20" fill="#dfb317"/>
|
||||
<rect width="95.5" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="32.0" y="15" fill="#010101" fill-opacity=".3">coverage</text>
|
||||
<text x="32.0" y="14">coverage</text>
|
||||
<text x="79.8" y="15" fill="#010101" fill-opacity=".3">44%</text>
|
||||
<text x="79.8" y="14">44%</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 919 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="dependencies: 349">
|
||||
<title>dependencies: 349</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="121.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="90.0" height="20" fill="#555"/>
|
||||
<rect x="90.0" width="31.5" height="20" fill="#007ec6"/>
|
||||
<rect width="121.5" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="45.0" y="15" fill="#010101" fill-opacity=".3">dependencies</text>
|
||||
<text x="45.0" y="14">dependencies</text>
|
||||
<text x="105.8" y="15" fill="#010101" fill-opacity=".3">349</text>
|
||||
<text x="105.8" y="14">349</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 940 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="89.0" height="20" role="img" aria-label="license: MIT">
|
||||
<title>license: MIT</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="89.0" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="57.5" height="20" fill="#555"/>
|
||||
<rect x="57.5" width="31.5" height="20" fill="#007ec6"/>
|
||||
<rect width="89.0" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="28.8" y="15" fill="#010101" fill-opacity=".3">license</text>
|
||||
<text x="28.8" y="14">license</text>
|
||||
<text x="73.2" y="15" fill="#010101" fill-opacity=".3">MIT</text>
|
||||
<text x="73.2" y="14">MIT</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 915 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="lines of code: 13.7K">
|
||||
<title>lines of code: 13.7K</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="141.0" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="96.5" height="20" fill="#555"/>
|
||||
<rect x="96.5" width="44.5" height="20" fill="#007ec6"/>
|
||||
<rect width="141.0" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="48.2" y="15" fill="#010101" fill-opacity=".3">lines of code</text>
|
||||
<text x="48.2" y="14">lines of code</text>
|
||||
<text x="118.8" y="15" fill="#010101" fill-opacity=".3">13.7K</text>
|
||||
<text x="118.8" y="14">13.7K</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 952 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="108.5" height="20" role="img" aria-label="code quality: A">
|
||||
<title>code quality: A</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="108.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="90.0" height="20" fill="#555"/>
|
||||
<rect x="90.0" width="18.5" height="20" fill="#4c1"/>
|
||||
<rect width="108.5" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="45.0" y="15" fill="#010101" fill-opacity=".3">code quality</text>
|
||||
<text x="45.0" y="14">code quality</text>
|
||||
<text x="99.2" y="15" fill="#010101" fill-opacity=".3">A</text>
|
||||
<text x="99.2" y="14">A</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 927 B |
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="tests: 95 passing">
|
||||
<title>tests: 95 passing</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="121.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="44.5" height="20" fill="#555"/>
|
||||
<rect x="44.5" width="77.0" height="20" fill="#4c1"/>
|
||||
<rect width="121.5" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="22.2" y="15" fill="#010101" fill-opacity=".3">tests</text>
|
||||
<text x="22.2" y="14">tests</text>
|
||||
<text x="83.0" y="15" fill="#010101" fill-opacity=".3">95 passing</text>
|
||||
<text x="83.0" y="14">95 passing</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 935 B |
@@ -0,0 +1,54 @@
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Write small badge artifacts to the private Gitea CI badge branch."""
|
||||
|
||||
import base64
|
||||
import json
|
||||
from urllib.error import HTTPError
|
||||
from urllib.parse import quote
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
BADGE_BRANCH = "ci-badges"
|
||||
|
||||
|
||||
def request_json(url: str, token: str, method: str = "GET",
|
||||
payload: dict | None = None) -> dict:
|
||||
body = None if payload is None else json.dumps(payload).encode()
|
||||
request = Request(url, data=body, method=method,
|
||||
headers={"Authorization": f"token {token}",
|
||||
"Content-Type": "application/json"})
|
||||
with urlopen(request, timeout=20) as response:
|
||||
return json.load(response)
|
||||
|
||||
|
||||
def publish_file(api: str, repo: str, filename: str, data: bytes,
|
||||
token: str, message: str, max_bytes: int = 65_536) -> None:
|
||||
if not filename or filename.startswith("/") or any(
|
||||
part in ("", ".", "..") for part in filename.split("/")):
|
||||
raise ValueError("invalid badge path")
|
||||
if len(data) > max_bytes:
|
||||
raise ValueError("artifact exceeds size limit")
|
||||
path = f"{api}/repos/{repo}/contents/{quote(filename, safe='/')}"
|
||||
encoded = base64.b64encode(data).decode("ascii")
|
||||
for attempt in range(3):
|
||||
try:
|
||||
current = request_json(path + "?ref=" + BADGE_BRANCH, token)
|
||||
if base64.b64decode(current["content"]) == data:
|
||||
return
|
||||
sha = current["sha"]
|
||||
method = "PUT"
|
||||
except HTTPError as error:
|
||||
if error.code != 404:
|
||||
raise
|
||||
sha = None
|
||||
method = "POST"
|
||||
payload = {"branch": BADGE_BRANCH, "content": encoded,
|
||||
"message": message + " [skip ci]"}
|
||||
if sha is not None:
|
||||
payload["sha"] = sha
|
||||
try:
|
||||
request_json(path, token, method, payload)
|
||||
return
|
||||
except HTTPError as error:
|
||||
if error.code not in (409, 422) or attempt == 2:
|
||||
raise
|
||||
raise RuntimeError("badge write did not complete")
|
||||
@@ -0,0 +1,110 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Check the Toolkit benchmark suite and compare it with the prior release."""
|
||||
import argparse
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
|
||||
# A Duration Debug token: a number immediately followed by a time unit, with the
|
||||
# multi-char units listed before the bare "s" so alternation prefers them. The
|
||||
# trailing (?![a-zA-Z]) stops "s" in words like "rows"/"cidrs" from matching.
|
||||
_DUR = re.compile(r"([0-9]+(?:\.[0-9]+)?)\s*(ns|\u00b5s|us|ms|s)(?![a-zA-Z])")
|
||||
_UNIT_NS = {"ns": 1.0, "us": 1e3, "\u00b5s": 1e3, "ms": 1e6, "s": 1e9}
|
||||
_NAME = re.compile(r"^(?:test [A-Za-z0-9_:]+ \.\.\. )?(bench_[A-Za-z0-9_]+)\s*:")
|
||||
EXPECTED_BENCHES = {
|
||||
"bench_verify_artifact", "bench_naming_transforms",
|
||||
"bench_parse_line_near_max_addrs", "bench_parse_targets_many_ranges_near_cap",
|
||||
"bench_targets_to_cidrs_large_range", "bench_view_pipeline",
|
||||
"bench_render_cells", "bench_health_diagnostics",
|
||||
"bench_view_pipeline_default_sort", "bench_sort_by_each_column",
|
||||
"bench_view_pipeline_with_filter", "bench_upsert_cold_start_population",
|
||||
}
|
||||
|
||||
|
||||
def parse_bench(text: str) -> dict:
|
||||
"""Map each bench name to its timing in nanoseconds (the last Duration on the
|
||||
line, since every bench prints its timing last)."""
|
||||
out = {}
|
||||
for line in text.splitlines():
|
||||
m = _NAME.match(line.strip())
|
||||
if not m:
|
||||
continue
|
||||
durs = _DUR.findall(line)
|
||||
if not durs:
|
||||
raise ValueError(f"missing timing for {m.group(1)}")
|
||||
val, unit = durs[-1]
|
||||
elapsed = float(val) * _UNIT_NS[unit]
|
||||
if m.group(1) in out or not math.isfinite(elapsed) or elapsed <= 0:
|
||||
raise ValueError(f"duplicate or invalid timing for {m.group(1)}")
|
||||
out[m.group(1)] = elapsed
|
||||
return out
|
||||
|
||||
|
||||
def require_suite(results: dict) -> dict:
|
||||
if results.keys() != EXPECTED_BENCHES:
|
||||
raise ValueError("microbenchmark results differ from the declared suite")
|
||||
return results
|
||||
|
||||
|
||||
def benchmark_delta(current: dict, baseline: dict) -> float | None:
|
||||
"""Average each comparable benchmark's percentage improvement."""
|
||||
if not baseline:
|
||||
return None
|
||||
changes = [(baseline[name] - current[name]) / baseline[name]
|
||||
for name in baseline]
|
||||
delta = math.fsum(changes) / len(changes) * 100
|
||||
if not math.isfinite(delta):
|
||||
raise ValueError("benchmark comparison is not finite")
|
||||
return delta
|
||||
|
||||
|
||||
def main() -> int:
|
||||
ap = argparse.ArgumentParser()
|
||||
ap.add_argument("--current", required=True, help="captured bench stdout")
|
||||
ap.add_argument("--baseline", required=True, help="baseline JSON (read + rewrite)")
|
||||
ap.add_argument("--no-write", action="store_true", help="do not update the baseline")
|
||||
args = ap.parse_args()
|
||||
|
||||
try:
|
||||
with open(args.current, encoding="utf-8") as fh:
|
||||
current = require_suite(parse_bench(fh.read()))
|
||||
except (OSError, ValueError) as e:
|
||||
print(f"bench-badge: cannot read current results: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
baseline = {}
|
||||
try:
|
||||
with open(args.baseline, encoding="utf-8") as fh:
|
||||
baseline = json.load(fh)
|
||||
except FileNotFoundError:
|
||||
pass
|
||||
except (OSError, ValueError) as e:
|
||||
print(f"bench-badge: invalid baseline: {e}", file=sys.stderr)
|
||||
return 1
|
||||
if (not isinstance(baseline, dict)
|
||||
or not set(baseline).issubset(current)
|
||||
or any(not isinstance(value, (int, float)) or isinstance(value, bool)
|
||||
or not math.isfinite(value) or value <= 0
|
||||
for value in baseline.values())):
|
||||
print("bench-badge: invalid or retired benchmark in baseline", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
try:
|
||||
delta = benchmark_delta(current, baseline)
|
||||
except ValueError as error:
|
||||
print(f"bench-badge: {error}", file=sys.stderr)
|
||||
return 1
|
||||
print("NEW" if delta is None else f"{delta:.1f}")
|
||||
|
||||
if not args.no_write:
|
||||
os.makedirs(os.path.dirname(args.baseline) or ".", exist_ok=True)
|
||||
with open(args.baseline, "w", encoding="utf-8") as fh:
|
||||
json.dump({k: round(v, 1) for k, v in sorted(current.items())}, fh, indent=2)
|
||||
fh.write("\n")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
# Measure only instrumented microbenchmarks, excluding unit and UI tests.
|
||||
set -euo pipefail
|
||||
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-config}"
|
||||
cargo llvm-cov clean --workspace
|
||||
cargo llvm-cov --no-report --offline --release -p alkane-gui -p alkane-artifacts -- \
|
||||
--ignored --nocapture bench_
|
||||
cargo llvm-cov report --release --ignore-filename-regex '(thirdparty|vendor)/' "$@"
|
||||
@@ -0,0 +1,166 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Keep measured main-branch benchmarks in the private CI artifact branch."""
|
||||
|
||||
import argparse
|
||||
import base64
|
||||
from datetime import datetime, timezone
|
||||
import html
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
from pathlib import Path
|
||||
import re
|
||||
import subprocess
|
||||
import importlib.util
|
||||
from urllib.error import HTTPError
|
||||
from urllib.parse import quote
|
||||
|
||||
from badge_store import BADGE_BRANCH, publish_file, request_json
|
||||
from bench_host import identity as benchmark_host
|
||||
|
||||
bench_spec = importlib.util.spec_from_file_location(
|
||||
"bench_badge", Path(__file__).with_name("bench-badge.py"))
|
||||
bench_badge = importlib.util.module_from_spec(bench_spec)
|
||||
bench_spec.loader.exec_module(bench_badge)
|
||||
|
||||
INDEX = "history/index.json"
|
||||
MAX_INDEX_ENTRIES = 50
|
||||
|
||||
|
||||
def read_artifact(api: str, repo: str, token: str, filename: str):
|
||||
url = f"{api}/repos/{repo}/contents/{quote(filename, safe='/')}?ref={BADGE_BRANCH}"
|
||||
try:
|
||||
value = request_json(url, token)
|
||||
except HTTPError as error:
|
||||
if error.code == 404:
|
||||
return None
|
||||
raise
|
||||
return json.loads(base64.b64decode(value["content"]))
|
||||
|
||||
|
||||
def valid_benches(metrics: dict) -> dict[str, float]:
|
||||
values = metrics.get("bench_ns_per_op")
|
||||
if not isinstance(values, dict) or not values:
|
||||
raise ValueError("benchmark measurements are missing")
|
||||
if any(not isinstance(key, str) or not re.fullmatch(r"[A-Za-z0-9_]+", key)
|
||||
or not isinstance(value, (float, int)) or isinstance(value, bool)
|
||||
or not math.isfinite(value) or value <= 0 for key, value in values.items()):
|
||||
raise ValueError("benchmark measurements are invalid")
|
||||
return values
|
||||
|
||||
|
||||
def git_distance(ancestor: str, sha: str) -> int | None:
|
||||
result = subprocess.run(("git", "rev-list", "--count", f"{ancestor}..{sha}"),
|
||||
capture_output=True, text=True, check=False)
|
||||
if result.returncode != 0:
|
||||
return None
|
||||
ancestor_check = subprocess.run(("git", "merge-base", "--is-ancestor", ancestor, sha),
|
||||
capture_output=True, check=False)
|
||||
return int(result.stdout.strip()) if ancestor_check.returncode == 0 else None
|
||||
|
||||
|
||||
def previous_measurement(index: dict, sha: str, distance=None, host=None) -> dict:
|
||||
distance = distance or git_distance
|
||||
choices = []
|
||||
for entry in index.get("entries", []):
|
||||
ancestor = entry.get("sha")
|
||||
if ancestor == sha or not isinstance(ancestor, str):
|
||||
continue
|
||||
if host is not None and entry.get("metrics", {}).get("bench_host") != host:
|
||||
continue
|
||||
gap = distance(ancestor, sha)
|
||||
if gap is not None and gap > 0:
|
||||
choices.append((gap, entry))
|
||||
if not choices:
|
||||
return {}
|
||||
return valid_benches(min(choices, key=lambda item: item[0])[1]["metrics"])
|
||||
|
||||
|
||||
def updated_index(index: dict, sha: str, metrics: dict, timestamp: str) -> dict:
|
||||
if not re.fullmatch(r"[0-9a-f]{40}", sha):
|
||||
raise ValueError("invalid commit SHA")
|
||||
valid_benches(metrics)
|
||||
entries = [entry for entry in index.get("entries", []) if entry.get("sha") != sha]
|
||||
entries.append({"sha": sha, "timestamp": timestamp, "metrics": metrics})
|
||||
return {"schema": 1, "entries": entries[-MAX_INDEX_ENTRIES:]}
|
||||
|
||||
|
||||
def render_html(index: dict) -> str:
|
||||
entries = list(reversed(index.get("entries", [])))
|
||||
names = sorted({name for entry in entries
|
||||
for name in valid_benches(entry["metrics"])})
|
||||
rows = []
|
||||
for entry in entries:
|
||||
sha = entry["sha"]
|
||||
if not re.fullmatch(r"[0-9a-f]{40}", sha):
|
||||
raise ValueError("invalid commit SHA in history")
|
||||
cells = [f'<td><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/commit/{sha}">{sha[:10]}</a></td>',
|
||||
f'<td>{html.escape(entry["timestamp"])}</td>']
|
||||
values = valid_benches(entry["metrics"])
|
||||
host = entry["metrics"].get("bench_host", {})
|
||||
host_label = host.get("cpu_model", "unknown") if isinstance(host, dict) else "unknown"
|
||||
cells.append(f'<td>{html.escape(str(host_label))}</td>')
|
||||
cells += [f'<td>{values[name]:.3f}</td>' if name in values else '<td>new</td>'
|
||||
for name in names]
|
||||
rows.append("<tr>" + "".join(cells) + "</tr>")
|
||||
headings = "".join(f"<th scope=\"col\">{html.escape(name)} (ns/op)</th>" for name in names)
|
||||
return ("<!doctype html>\n<html lang=\"en\"><head><meta charset=\"utf-8\">"
|
||||
"<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">"
|
||||
"<title>Alkane Toolkit benchmarks</title><style>"
|
||||
"body{font:16px system-ui,sans-serif;max-width:1100px;margin:2rem auto;padding:0 1rem;color:#17212b}"
|
||||
"h1{font-size:2rem}p{max-width:70ch;line-height:1.5}"
|
||||
"table{border-collapse:collapse;min-width:100%}th,td{padding:.5rem;border-bottom:1px solid #ccd3da;text-align:right}"
|
||||
"th:first-child,td:first-child{text-align:left}th:nth-child(2),td:nth-child(2){text-align:left}"
|
||||
"th{background:#edf2f6;position:sticky;top:0}a{color:#145a9a}"
|
||||
".scroll{overflow-x:auto}small{color:#55616d}</style></head><body>"
|
||||
"<h1>Alkane Toolkit microbenchmarks</h1>"
|
||||
"<p>Measured on main CI. Lower ns/op is faster. Results depend on runner load and are "
|
||||
"not board performance. A new benchmark has no earlier comparison.</p>"
|
||||
f"<p><small>Most recent {len(entries)} measured commits. Full per-commit JSON is retained "
|
||||
"in the private ci-badges branch.</small></p>"
|
||||
f"<div class=\"scroll\"><table><thead><tr><th scope=\"col\">Commit</th>"
|
||||
f"<th scope=\"col\">UTC</th><th scope=\"col\">CPU</th>{headings}</tr></thead><tbody>{''.join(rows)}"
|
||||
"</tbody></table></div></body></html>\n")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("action", choices=("prepare", "publish", "render"))
|
||||
args = parser.parse_args()
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
sha = os.environ["GITHUB_SHA"]
|
||||
index = read_artifact(api, repo, token, INDEX) or {"schema": 1, "entries": []}
|
||||
if index.get("schema") != 1 or not isinstance(index.get("entries"), list):
|
||||
raise ValueError("unsupported benchmark history index")
|
||||
if args.action == "prepare":
|
||||
baseline = previous_measurement(index, sha, host=benchmark_host())
|
||||
Path("badges").mkdir(exist_ok=True)
|
||||
Path("badges/bench-baseline.json").write_text(json.dumps(baseline) + "\n")
|
||||
print(f"Loaded {len(baseline)} prior benchmark measurements")
|
||||
return
|
||||
if args.action == "render":
|
||||
if not index["entries"]:
|
||||
raise ValueError("no measured benchmark history to publish")
|
||||
Path("bench-site").mkdir(exist_ok=True)
|
||||
Path("bench-site/index.html").write_text(render_html(index))
|
||||
print(f"Rendered {len(index['entries'])} measured benchmark commits")
|
||||
return
|
||||
metrics = {"bench_ns_per_op": bench_badge.require_suite(bench_badge.parse_bench(
|
||||
Path("bench-current.txt").read_text())), "bench_host": benchmark_host()}
|
||||
timestamp = datetime.now(timezone.utc).isoformat(timespec="seconds")
|
||||
index = updated_index(index, sha, metrics, timestamp)
|
||||
record = json.dumps(index["entries"][-1], indent=2).encode() + b"\n"
|
||||
publish_file(api, repo, f"history/{sha}.json", record, token,
|
||||
"Record Alkane Toolkit benchmarks", max_bytes=1_048_576)
|
||||
publish_file(api, repo, INDEX, json.dumps(index, indent=2).encode() + b"\n",
|
||||
token, "Update Alkane Toolkit benchmark index", max_bytes=1_048_576)
|
||||
Path("bench-site").mkdir(exist_ok=True)
|
||||
Path("bench-site/index.html").write_text(render_html(index))
|
||||
print(f"Recorded benchmarks for {sha[:10]}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Identify the CPU class used for comparable CI microbenchmark baselines."""
|
||||
|
||||
import os
|
||||
import platform
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def identity() -> dict[str, object]:
|
||||
model = "unknown"
|
||||
cpuinfo = Path("/proc/cpuinfo")
|
||||
if cpuinfo.is_file():
|
||||
for line in cpuinfo.read_text(errors="replace").splitlines():
|
||||
if line.startswith(("model name\t", "Hardware\t", "Processor\t")):
|
||||
model = line.partition(":")[2].strip()[:160]
|
||||
break
|
||||
return {"architecture": platform.machine(), "cpu_model": model,
|
||||
"logical_cpus": os.cpu_count() or 1}
|
||||
@@ -0,0 +1,42 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Remove generated Toolkit CI work after the release asset is uploaded."""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import sys
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
DIRECTORIES = ("target", "dist", "coverage", "bench-site")
|
||||
FILES = ("bench-current.txt",)
|
||||
|
||||
|
||||
def cleanup() -> None:
|
||||
if not os.environ.get("GITHUB_RUN_ID"):
|
||||
raise ValueError("cleanup is restricted to CI runs")
|
||||
for name in DIRECTORIES:
|
||||
path = ROOT / name
|
||||
if path.is_symlink() or path.parent.resolve() != ROOT.resolve():
|
||||
raise ValueError(f"unsafe generated directory: {path}")
|
||||
if path.is_dir():
|
||||
shutil.rmtree(path)
|
||||
print(f"Removed generated directory: {name}")
|
||||
elif path.exists():
|
||||
raise ValueError(f"expected a generated directory: {path}")
|
||||
for name in FILES:
|
||||
path = ROOT / name
|
||||
if path.is_symlink() or path.parent.resolve() != ROOT.resolve():
|
||||
raise ValueError(f"unsafe generated file: {path}")
|
||||
if path.is_file():
|
||||
path.unlink()
|
||||
print(f"Removed generated file: {name}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
cleanup()
|
||||
except (OSError, ValueError) as error:
|
||||
print(f"ERROR: Toolkit cleanup: {error}", file=sys.stderr)
|
||||
raise SystemExit(1)
|
||||
@@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
# Convert the next final version into a monotonically numbered prerelease.
|
||||
set -euo pipefail
|
||||
result="$(bash ci/compute-version.sh)"
|
||||
release="$(printf '%s\n' "$result" | sed -n 's/^release=//p')"
|
||||
if [ "$release" != true ]; then
|
||||
echo "release=false"
|
||||
exit 0
|
||||
fi
|
||||
version="$(printf '%s\n' "$result" | sed -n 's/^version=//p')"
|
||||
last="$(git tag -l "v${version}-rc.*" | sed -n "s/^v${version//./\.}-rc\.\([0-9][0-9]*\)$/\1/p" | sort -n | tail -1)"
|
||||
next=$(( ${last:-0} + 1 ))
|
||||
echo "release=true"
|
||||
echo "version=${version}-rc.${next}"
|
||||
echo "tag=v${version}-rc.${next}"
|
||||
@@ -2,9 +2,10 @@
|
||||
# Compute the next release version for alkane-toolkit from the latest release
|
||||
# tag and the paths changed since it. Version scheme X.Y.Z:
|
||||
# X - major, bumped manually (ci/version-x.txt); a bump resets Y.Z to 0.0
|
||||
# Y - backend-logic changes (core/discovery/access/flash/artifacts/cli,
|
||||
# scan+model+main in the GUI crate, build/CI config); resets Z to 0
|
||||
# Z - UI changes (the GUI view + fixtures + the wx-rs widget bridge)
|
||||
# Y - backend-logic changes (the alkane-* crates and any GUI crate source
|
||||
# other than the view files below, plus vendored deps and build/CI config);
|
||||
# resets Z to 0
|
||||
# Z - UI changes (the GUI view: ui.rs + fixtures.rs + bin/ + the wx-rs bridge)
|
||||
# When both backend and UI changed, backend wins (bump Y). Docs-only changes
|
||||
# produce no release.
|
||||
#
|
||||
@@ -17,7 +18,7 @@ X=0
|
||||
[ -f "$x_file" ] && X=$(tr -dc '0-9' < "$x_file")
|
||||
X=${X:-0}
|
||||
|
||||
last=$(git tag -l 'v*.*.*' | sort -V | tail -1 || true)
|
||||
last=$(git tag -l 'v*.*.*' | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -1 || true)
|
||||
if [ -n "$last" ]; then
|
||||
v=${last#v}; lx=${v%%.*}; rest=${v#*.}; ly=${rest%%.*}; lz=${rest##*.}
|
||||
changed=$(git diff --name-only "$last"..HEAD)
|
||||
@@ -30,12 +31,16 @@ ui=false; backend=false
|
||||
while IFS= read -r f; do
|
||||
[ -z "$f" ] && continue
|
||||
case "$f" in
|
||||
crates/alkane-gui/src/ui.rs|crates/alkane-gui/src/fixtures.rs|thirdparty/wx-rs/*)
|
||||
crates/alkane-gui/src/ui.rs|crates/alkane-gui/src/fixtures.rs|thirdparty/wx-rs/*|\
|
||||
crates/alkane-gui/src/bin/*)
|
||||
ui=true ;;
|
||||
crates/alkane-core/*|crates/alkane-discovery/*|crates/alkane-access/*|\
|
||||
crates/alkane-flash/*|crates/alkane-artifacts/*|crates/alkane-cli/*|\
|
||||
crates/alkane-gui/src/scan.rs|crates/alkane-gui/src/model.rs|\
|
||||
crates/alkane-gui/src/main.rs|Cargo.toml|Cargo.lock|.gitea/*|ci/*|scripts/*)
|
||||
crates/alkane-gui/src/*|Cargo.toml|Cargo.lock|.gitea/*|ci/*|scripts/*|\
|
||||
vendor/*|thirdparty/asic-rs/*)
|
||||
# Any other GUI source file (naming, scan, model, pool_prefs, restore,
|
||||
# access_probe, credentials, ...) is backend logic. ui.rs/fixtures.rs/bin
|
||||
# match the UI arm above first, so they still bump Z, not Y.
|
||||
backend=true ;;
|
||||
*) : ;; # docs, HANDOFF, README, thirdparty/wxwidgets tree: no bump
|
||||
esac
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
#!/usr/bin/env bash
|
||||
# Measure line coverage from BOTH the unit tests AND the headless UI self-test.
|
||||
#
|
||||
# The self-test (ALKANE_SELFTEST=1) builds the real wxWidgets table, renders every
|
||||
# fixture through the real widgets, and checks each cell against the model.
|
||||
# It covers the fixture-rendering path, while interactive event handlers need
|
||||
# separate tests. Because it runs as a separate binary invocation, a plain
|
||||
# `cargo llvm-cov` (which only runs the #[test]s) never counts it. This
|
||||
# combines both runs' coverage.
|
||||
#
|
||||
# Usage: ci/coverage.sh [extra `cargo llvm-cov report` args, e.g. --summary-only]
|
||||
set -euo pipefail
|
||||
|
||||
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-config}"
|
||||
|
||||
# The dependency tree is fully vendored, so the instrumented builds run offline by
|
||||
# default; override with CARGO_LLVM_COV_FLAGS if you need something else.
|
||||
read -ra CARGO_FLAGS <<<"${CARGO_LLVM_COV_FLAGS:---offline}"
|
||||
|
||||
# A display is required for the self-test; skipping it would publish an
|
||||
# incomplete coverage number as if the measured test set had run.
|
||||
if ! command -v xvfb-run >/dev/null 2>&1; then
|
||||
echo "coverage.sh: xvfb-run is required for the UI self-test" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cargo llvm-cov clean --workspace
|
||||
|
||||
# 1. Unit tests for the GUI and the artifact/flash/CLI crates.
|
||||
cargo llvm-cov --no-report "${CARGO_FLAGS[@]}" -p alkane-gui --bin alkane-toolkit
|
||||
cargo llvm-cov --no-report "${CARGO_FLAGS[@]}" \
|
||||
-p alkane-artifacts -p alkane-flash -p alkane-cli
|
||||
|
||||
# 2. Headless UI self-test, under the same instrumentation, its coverage appended.
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 \
|
||||
cargo llvm-cov run --no-report "${CARGO_FLAGS[@]}" --bin alkane-toolkit
|
||||
|
||||
# 3. Merged report, our source only (vendored asic-rs + the patched wx-rs bridge
|
||||
# are out of scope).
|
||||
cargo llvm-cov report --ignore-filename-regex '(thirdparty|vendor)/' "$@"
|
||||
@@ -0,0 +1,219 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Generate self-contained shields-style SVG badges into badges/.
|
||||
|
||||
Main CI regenerates SVGs from measured metrics and publishes them to the
|
||||
private ci-badges branch. The README loads those authenticated raw artifacts.
|
||||
|
||||
Usage:
|
||||
gen-badges.py --tests N --coverage PCT --bench "label" [--out badges]
|
||||
|
||||
Metrics not passed on the command line are computed here (LOC from the source
|
||||
tree, dependency count from Cargo.lock, license from Cargo.toml).
|
||||
"""
|
||||
import argparse
|
||||
import math
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
|
||||
# Approximate per-character width at 11px DejaVu Sans, in 1/10 px, matching the
|
||||
# shields "flat" look closely enough for a fixed-width monospace-ish render.
|
||||
CHAR_W = 6.5
|
||||
PAD = 6.0
|
||||
|
||||
COLORS = {
|
||||
"green": "#4c1",
|
||||
"brightgreen": "#4c1",
|
||||
"yellowgreen": "#a4a61d",
|
||||
"yellow": "#dfb317",
|
||||
"orange": "#fe7d37",
|
||||
"red": "#e05d44",
|
||||
"blue": "#007ec6",
|
||||
"lightgrey": "#9f9f9f",
|
||||
"grey": "#555",
|
||||
}
|
||||
|
||||
|
||||
def text_width(s: str) -> float:
|
||||
return len(s) * CHAR_W + 2 * PAD
|
||||
|
||||
|
||||
def badge_svg(label: str, message: str, color: str) -> str:
|
||||
color = COLORS.get(color, color)
|
||||
lw = round(text_width(label), 1)
|
||||
mw = round(text_width(message), 1)
|
||||
total = round(lw + mw, 1)
|
||||
lx = round(lw / 2, 1)
|
||||
mx = round(lw + mw / 2, 1)
|
||||
# Text is drawn twice (a dark shadow then the light glyphs) for the shields look.
|
||||
return f'''<svg xmlns="http://www.w3.org/2000/svg" width="{total}" height="20" role="img" aria-label="{label}: {message}">
|
||||
<title>{label}: {message}</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="{total}" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="{lw}" height="20" fill="#555"/>
|
||||
<rect x="{lw}" width="{mw}" height="20" fill="{color}"/>
|
||||
<rect width="{total}" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="{lx}" y="15" fill="#010101" fill-opacity=".3">{label}</text>
|
||||
<text x="{lx}" y="14">{label}</text>
|
||||
<text x="{mx}" y="15" fill="#010101" fill-opacity=".3">{message}</text>
|
||||
<text x="{mx}" y="14">{message}</text>
|
||||
</g>
|
||||
</svg>
|
||||
'''
|
||||
|
||||
|
||||
def count_loc(root: str) -> int:
|
||||
total = 0
|
||||
for base in ("crates",):
|
||||
for dirpath, _dirs, files in os.walk(os.path.join(root, base)):
|
||||
for f in files:
|
||||
if f.endswith(".rs"):
|
||||
try:
|
||||
with open(os.path.join(dirpath, f), encoding="utf-8", errors="ignore") as fh:
|
||||
total += sum(1 for _ in fh)
|
||||
except OSError:
|
||||
pass
|
||||
return total
|
||||
|
||||
|
||||
def count_deps(root: str) -> int:
|
||||
lock = os.path.join(root, "Cargo.lock")
|
||||
try:
|
||||
with open(lock, encoding="utf-8") as fh:
|
||||
return sum(1 for line in fh if line.startswith("name = "))
|
||||
except OSError:
|
||||
return 0
|
||||
|
||||
|
||||
def read_license(root: str) -> str:
|
||||
try:
|
||||
with open(os.path.join(root, "Cargo.toml"), encoding="utf-8") as fh:
|
||||
for line in fh:
|
||||
m = re.match(r'\s*license\s*=\s*"([^"]+)"', line)
|
||||
if m:
|
||||
return m.group(1)
|
||||
except OSError:
|
||||
pass
|
||||
return "unknown"
|
||||
|
||||
|
||||
def loc_color(n: int) -> str:
|
||||
return "blue"
|
||||
|
||||
|
||||
def bench_color(delta_pct: float) -> str:
|
||||
# Positive delta means faster than the previous release. A +/-2% band
|
||||
# absorbs run-to-run jitter on the dedicated CI runner.
|
||||
if delta_pct >= 2.0:
|
||||
return "brightgreen"
|
||||
if delta_pct > -2.0:
|
||||
return "blue"
|
||||
if delta_pct > -10.0:
|
||||
return "yellow"
|
||||
return "orange"
|
||||
|
||||
|
||||
def cov_color(pct: float) -> str:
|
||||
if pct >= 80:
|
||||
return "brightgreen"
|
||||
if pct >= 60:
|
||||
return "yellowgreen"
|
||||
if pct >= 40:
|
||||
return "yellow"
|
||||
if pct >= 20:
|
||||
return "orange"
|
||||
return "red"
|
||||
|
||||
|
||||
def quality_grade(clippy: str | None) -> str:
|
||||
if clippy is None:
|
||||
return "pending"
|
||||
return "A" if clippy == "clean" else "F"
|
||||
|
||||
|
||||
def human(n: int) -> str:
|
||||
suffixes = ("", "K", "M", "G")
|
||||
value = float(n)
|
||||
index = 0
|
||||
while value >= 999.5 and index < len(suffixes) - 1:
|
||||
value /= 1000
|
||||
index += 1
|
||||
if value >= 100:
|
||||
number = f"{value:.0f}"
|
||||
elif value >= 10:
|
||||
number = f"{value:.1f}".rstrip("0").rstrip(".")
|
||||
else:
|
||||
number = f"{value:.2f}".rstrip("0").rstrip(".")
|
||||
return number + suffixes[index]
|
||||
|
||||
|
||||
def main() -> int:
|
||||
ap = argparse.ArgumentParser()
|
||||
ap.add_argument("--out", default="badges")
|
||||
ap.add_argument("--root", default=".")
|
||||
ap.add_argument("--tests", type=int, default=None)
|
||||
ap.add_argument("--coverage", type=float, default=None)
|
||||
ap.add_argument("--bench-coverage", type=float, default=None)
|
||||
ap.add_argument("--bench", default=None)
|
||||
# Mean per-benchmark improvement vs the previous release, as a signed
|
||||
# percentage string, or "NEW" when there is no baseline.
|
||||
ap.add_argument("--bench-delta", default=None)
|
||||
ap.add_argument("--clippy", choices=("clean", "failed"))
|
||||
args = ap.parse_args()
|
||||
for value in (args.coverage, args.bench_coverage):
|
||||
if value is not None and (not math.isfinite(value) or not 0 <= value <= 100):
|
||||
ap.error("coverage must be a finite percentage between 0 and 100")
|
||||
|
||||
os.makedirs(os.path.join(args.root, args.out), exist_ok=True)
|
||||
|
||||
def write(name, label, message, color):
|
||||
path = os.path.join(args.root, args.out, name + ".svg")
|
||||
with open(path, "w", encoding="utf-8") as fh:
|
||||
fh.write(badge_svg(label, message, color))
|
||||
print(f"wrote {path}: {label}={message}")
|
||||
|
||||
loc = count_loc(args.root)
|
||||
deps = count_deps(args.root)
|
||||
lic = read_license(args.root)
|
||||
|
||||
write("loc", "lines of code", human(loc), loc_color(loc))
|
||||
write("license", "license", lic, "blue")
|
||||
write("dependencies", "dependencies", str(deps), "blue")
|
||||
grade = quality_grade(args.clippy)
|
||||
write("quality", "code quality", grade,
|
||||
{"A": "brightgreen", "B": "yellowgreen", "C": "yellow",
|
||||
"D": "orange", "F": "red", "pending": "lightgrey"}[grade])
|
||||
if args.tests is not None:
|
||||
write("tests", "tests", f"{args.tests} passing", "brightgreen")
|
||||
if args.coverage is not None:
|
||||
write("coverage", "coverage", f"{args.coverage:.0f}%", cov_color(args.coverage))
|
||||
write("bench-coverage", "bench coverage",
|
||||
f"{args.bench_coverage:.0f}%" if args.bench_coverage is not None else "pending",
|
||||
cov_color(args.bench_coverage) if args.bench_coverage is not None else "lightgrey")
|
||||
# Bench badge: prefer the mean per-benchmark improvement vs the previous
|
||||
# release. Use the static label when no comparison is available.
|
||||
delta = None
|
||||
if args.bench_delta not in (None, "", "NEW"):
|
||||
try:
|
||||
delta = float(args.bench_delta)
|
||||
except ValueError:
|
||||
delta = None
|
||||
if delta is not None:
|
||||
# Positive = faster than the previous release.
|
||||
msg = f"{'+' if delta > 0 else ''}{delta:.1f}% vs prev"
|
||||
write("bench", "bench", msg, bench_color(delta))
|
||||
elif args.bench_delta == "NEW":
|
||||
write("bench", "bench", "baseline set", "blue")
|
||||
elif args.bench is not None:
|
||||
write("bench", "bench", args.bench, "blue")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,115 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Publish the last completed main/next CI result to a private badge branch."""
|
||||
|
||||
import base64
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
from urllib.error import HTTPError
|
||||
from urllib.parse import quote, urlencode
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
|
||||
WORKFLOWS = {"release.yml": "main", "next.yml": "next"}
|
||||
BADGE_BRANCH = "ci-badges"
|
||||
|
||||
|
||||
def badge(branch: str, conclusion: str, run_id: int) -> bytes:
|
||||
passed = conclusion == "success"
|
||||
word = "pass" if passed else "fail"
|
||||
color = "#2ea043" if passed else "#d1242f"
|
||||
title = f"CI {branch}: last completed attempt {word} (run {run_id})"
|
||||
return (f'<svg xmlns="http://www.w3.org/2000/svg" width="102" height="20" '
|
||||
f'role="img" aria-label="{title}"><title>{title}</title>'
|
||||
'<rect width="102" height="20" rx="3" fill="#555"/>'
|
||||
f'<path d="M39 0h60a3 3 0 0 1 3 3v14a3 3 0 0 1-3 3H39z" fill="{color}"/>'
|
||||
'<text x="20" y="14" fill="#fff" text-anchor="middle" '
|
||||
'font-family="sans-serif" font-size="11">CI</text>'
|
||||
f'<text x="70" y="14" fill="#fff" text-anchor="middle" '
|
||||
f'font-family="sans-serif" font-size="11">{word}</text></svg>\n').encode()
|
||||
|
||||
|
||||
def request_json(url: str, token: str, method: str = "GET",
|
||||
payload: dict | None = None) -> dict:
|
||||
body = None if payload is None else json.dumps(payload).encode()
|
||||
request = Request(url, data=body, method=method,
|
||||
headers={"Authorization": f"token {token}",
|
||||
"Content-Type": "application/json"})
|
||||
with urlopen(request, timeout=20) as response:
|
||||
return json.load(response)
|
||||
|
||||
|
||||
def latest_completed(api: str, repo: str, workflow: str, branch: str,
|
||||
token: str) -> tuple[int, str]:
|
||||
path = quote(workflow, safe="")
|
||||
latest = None
|
||||
for page in range(1, 21):
|
||||
query = urlencode({"branch": branch, "limit": 50, "page": page})
|
||||
url = f"{api}/repos/{repo}/actions/workflows/{path}/runs?{query}"
|
||||
runs = request_json(url, token).get("workflow_runs", [])
|
||||
for run in runs:
|
||||
if run.get("head_branch") != branch or run.get("status") != "completed":
|
||||
continue
|
||||
if run.get("conclusion") not in ("success", "failure"):
|
||||
continue
|
||||
candidate = (int(run["id"]), run["conclusion"])
|
||||
if latest is None or candidate[0] > latest[0]:
|
||||
latest = candidate
|
||||
if len(runs) < 50:
|
||||
break
|
||||
if latest is None:
|
||||
raise RuntimeError(f"no completed {branch} run found for {workflow}")
|
||||
return latest
|
||||
|
||||
|
||||
def publish(api: str, repo: str, branch: str, data: bytes, token: str) -> None:
|
||||
path = f"{api}/repos/{repo}/contents/{branch}.svg"
|
||||
encoded = base64.b64encode(data).decode("ascii")
|
||||
for attempt in range(3):
|
||||
try:
|
||||
current = request_json(path + "?ref=" + BADGE_BRANCH, token)
|
||||
current_data = base64.b64decode(current["content"])
|
||||
if current_data == data:
|
||||
return
|
||||
sha = current["sha"]
|
||||
method = "PUT"
|
||||
except HTTPError as error:
|
||||
if error.code != 404:
|
||||
raise
|
||||
sha = None
|
||||
method = "POST"
|
||||
payload = {"branch": BADGE_BRANCH, "content": encoded,
|
||||
"message": f"Record completed {branch} CI attempt"}
|
||||
if sha is not None:
|
||||
payload["sha"] = sha
|
||||
try:
|
||||
request_json(path, token, method, payload)
|
||||
return
|
||||
except HTTPError as error:
|
||||
if error.code not in (409, 422) or attempt == 2:
|
||||
raise
|
||||
raise RuntimeError("badge write did not complete")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
event = json.loads(Path(os.environ["GITHUB_EVENT_PATH"]).read_text())
|
||||
if event.get("action") != "completed":
|
||||
raise RuntimeError("expected a completed workflow_run event")
|
||||
run = event["workflow_run"]
|
||||
workflow = run["path"].split("@", 1)[0].rsplit("/", 1)[-1]
|
||||
expected_branch = WORKFLOWS.get(workflow)
|
||||
if expected_branch is None or run.get("head_branch") != expected_branch:
|
||||
raise RuntimeError("unexpected workflow or branch")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
if event["repository"]["full_name"] != repo:
|
||||
raise RuntimeError("repository mismatch")
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
run_id, conclusion = latest_completed(api, repo, workflow, expected_branch, token)
|
||||
publish(api, repo, expected_branch, badge(expected_branch, conclusion, run_id), token)
|
||||
print(f"{expected_branch} badge records completed run {run_id}: {conclusion}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,121 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Publish a measured benchmark page to the public, data-only Pages repo."""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
import shlex
|
||||
import subprocess
|
||||
import tempfile
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
PAGES_REPO = "ssh://git@gitea.bluefla.re:2222/blueflare/alkane-benchmarks.git"
|
||||
GUARD_REPO = "https://gitea.bluefla.re/blueflare/alkane-benchmarks.git"
|
||||
GUARD_COMMIT = "ea160545c49bc419a245692deda8dd7db7a611eb"
|
||||
PAGES_HOST = "gitea.bluefla.re"
|
||||
PAGES_HOST_FINGERPRINT = "SHA256:lqB5cmC9E5HNeg/lkzdOwQ++I8A70Wx7lnNs6liN24g"
|
||||
PAGES_HOST_KEY = "[gitea.bluefla.re]:2222 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO1II6NkmRW+QAd+Wj+7qbNrA8Oo+/N/WRog4hELskn/"
|
||||
|
||||
|
||||
def run(*args: str, env: dict[str, str] | None = None,
|
||||
cwd: Path | None = None) -> subprocess.CompletedProcess[str]:
|
||||
return subprocess.run(args, env=env, cwd=cwd, text=True,
|
||||
capture_output=True, check=True)
|
||||
|
||||
|
||||
def current_main_sha() -> str:
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
request = Request(f"{api}/repos/{repo}/branches/main",
|
||||
headers={"Authorization": f"token {token}"})
|
||||
with urlopen(request, timeout=20) as response:
|
||||
branch = json.load(response)
|
||||
return branch["commit"]["id"]
|
||||
|
||||
|
||||
def publish(site: str) -> None:
|
||||
if os.environ.get("GITHUB_REF") != "refs/heads/main":
|
||||
raise ValueError("benchmark Pages publication requires main")
|
||||
sha = os.environ["GITHUB_SHA"]
|
||||
if current_main_sha() != sha:
|
||||
print("Skipping benchmark page from a superseded main commit")
|
||||
return
|
||||
page = Path("bench-site/index.html").read_bytes()
|
||||
if not page.startswith(b"<!doctype html>") or len(page) > 1_048_576:
|
||||
raise ValueError("invalid benchmark page")
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-pages-") as directory:
|
||||
temporary = Path(directory)
|
||||
guard_checkout = temporary / "guard"
|
||||
run("git", "clone", "--quiet", "--single-branch", "--branch", "next",
|
||||
GUARD_REPO, str(guard_checkout))
|
||||
guard_source = run("git", "show", f"{GUARD_COMMIT}:ci/validate_site.py",
|
||||
cwd=guard_checkout).stdout
|
||||
guard_script = temporary / "validate_site.py"
|
||||
guard_script.write_text(guard_source)
|
||||
run("python3", str(guard_script), "--page", site,
|
||||
str(Path("bench-site/index.html").resolve()))
|
||||
key = os.environ["BENCH_PAGES_DEPLOY_KEY"]
|
||||
if not key.startswith("-----BEGIN OPENSSH PRIVATE KEY-----"):
|
||||
raise ValueError("missing benchmark Pages deploy key")
|
||||
key_path = temporary / "deploy_key"
|
||||
key_path.write_text(key.rstrip("\n") + "\n")
|
||||
key_path.chmod(0o600)
|
||||
known_hosts = temporary / "known_hosts"
|
||||
known_hosts.write_text(PAGES_HOST_KEY + "\n")
|
||||
fingerprint = run("ssh-keygen", "-lf", str(known_hosts)).stdout.split()[1]
|
||||
if fingerprint != PAGES_HOST_FINGERPRINT:
|
||||
raise ValueError("benchmark Pages SSH host key changed")
|
||||
git_env = os.environ.copy()
|
||||
ssh_command = (f"ssh -i {shlex.quote(str(key_path))} -o IdentitiesOnly=yes "
|
||||
f"-o UserKnownHostsFile={shlex.quote(str(known_hosts))} "
|
||||
"-o StrictHostKeyChecking=yes -o ConnectTimeout=10")
|
||||
git_env["GIT_SSH_COMMAND"] = ssh_command
|
||||
git_env["GIT_TERMINAL_PROMPT"] = "0"
|
||||
checkout = temporary / "site"
|
||||
run("git", "clone", "--quiet", "--single-branch", "--branch", "gh-pages",
|
||||
PAGES_REPO, str(checkout), env=git_env)
|
||||
run("git", "config", "user.name", "Alkane CI", cwd=checkout)
|
||||
run("git", "config", "user.email", "ci@bluefla.re", cwd=checkout)
|
||||
for attempt in range(3):
|
||||
if current_main_sha() != sha:
|
||||
print("Skipping benchmark page from a superseded main commit")
|
||||
return
|
||||
run("git", "fetch", "--quiet", "origin", "gh-pages", env=git_env,
|
||||
cwd=checkout)
|
||||
run("git", "checkout", "-q", "-B", "bench-publish", "origin/gh-pages",
|
||||
cwd=checkout)
|
||||
destination = checkout / site / "index.html"
|
||||
destination.parent.mkdir(exist_ok=True)
|
||||
destination.write_bytes(page)
|
||||
run("git", "add", f"{site}/index.html", cwd=checkout)
|
||||
changed = subprocess.run(("git", "diff", "--cached", "--quiet"),
|
||||
cwd=checkout, check=False)
|
||||
if changed.returncode == 0:
|
||||
print(f"{site} benchmark page is already current")
|
||||
return
|
||||
if changed.returncode != 1:
|
||||
raise RuntimeError("cannot compare benchmark page")
|
||||
run("git", "commit", "-q", "-m",
|
||||
f"Update {site} benchmarks for {sha[:10]} [skip ci]", cwd=checkout)
|
||||
pushed = subprocess.run(("git", "push", "--quiet", "origin",
|
||||
"HEAD:gh-pages"), env=git_env, cwd=checkout,
|
||||
text=True, capture_output=True, check=False)
|
||||
if pushed.returncode == 0:
|
||||
print(f"Published {site} benchmark page for {sha[:10]}")
|
||||
return
|
||||
if attempt == 2:
|
||||
raise RuntimeError(f"benchmark Pages push failed: {pushed.stderr.strip()}")
|
||||
raise RuntimeError("benchmark Pages publication did not complete")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("site", choices=("sdk", "os", "toolkit"))
|
||||
publish(parser.parse_args().site)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Publish measured toolkit badges to the private Gitea badge branch."""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
from badge_store import publish_file
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
NAMES = ("tests", "coverage", "bench", "bench-coverage", "loc",
|
||||
"dependencies", "quality", "license")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
for name in NAMES:
|
||||
data = (ROOT / "badges" / f"{name}.svg").read_bytes()
|
||||
if not data.lstrip().startswith(b"<svg"):
|
||||
raise ValueError(f"invalid {name} SVG")
|
||||
publish_file(api, repo, f"badges/{name}.svg", data, token,
|
||||
f"Update measured {name} badge")
|
||||
print(f"Published {len(NAMES)} measured badge SVGs")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,56 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Create one Gitea release and attach files using the runner's scoped token."""
|
||||
|
||||
import json
|
||||
import os
|
||||
import pathlib
|
||||
import sys
|
||||
import urllib.error
|
||||
import urllib.parse
|
||||
import urllib.request
|
||||
|
||||
|
||||
def request(url, payload, content_type):
|
||||
headers = {
|
||||
"Authorization": "token " + os.environ["GITEA_TOKEN"],
|
||||
"Content-Type": content_type,
|
||||
}
|
||||
req = urllib.request.Request(url, data=payload, headers=headers, method="POST")
|
||||
with urllib.request.urlopen(req, timeout=60) as response:
|
||||
return json.load(response)
|
||||
|
||||
|
||||
def main():
|
||||
if len(sys.argv) < 4:
|
||||
sys.exit("usage: release.py TAG PRERELEASE FILE [FILE ...]")
|
||||
tag, prerelease, *files = sys.argv[1:]
|
||||
api = os.environ.get("GITHUB_API_URL", "https://gitea.bluefla.re/api/v1").rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
sha = os.environ["GITHUB_SHA"]
|
||||
body = f"Automated Alkane toolkit build from {sha}."
|
||||
metadata = {
|
||||
"tag_name": tag,
|
||||
"target_commitish": sha,
|
||||
"name": tag,
|
||||
"body": body,
|
||||
"prerelease": prerelease.lower() == "true",
|
||||
}
|
||||
try:
|
||||
release = request(f"{api}/repos/{repo}/releases", json.dumps(metadata).encode(), "application/json")
|
||||
except urllib.error.HTTPError as exc:
|
||||
sys.exit(f"release creation failed: HTTP {exc.code}")
|
||||
release_id = release["id"]
|
||||
for name in files:
|
||||
path = pathlib.Path(name)
|
||||
query = urllib.parse.urlencode({"name": path.name})
|
||||
try:
|
||||
request(f"{api}/repos/{repo}/releases/{release_id}/assets?{query}",
|
||||
path.read_bytes(), "application/octet-stream")
|
||||
except urllib.error.HTTPError as exc:
|
||||
sys.exit(f"asset upload failed for {path.name}: HTTP {exc.code}")
|
||||
print(f"Created {tag} with {len(files)} assets")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,55 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Check that every Toolkit benchmark contributes to the release badge."""
|
||||
|
||||
import importlib.util
|
||||
import re
|
||||
from pathlib import Path
|
||||
import unittest
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
spec = importlib.util.spec_from_file_location("bench_badge", ROOT / "ci/bench-badge.py")
|
||||
assert spec is not None and spec.loader is not None
|
||||
badge = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(badge)
|
||||
badge_spec = importlib.util.spec_from_file_location("gen_badges", ROOT / "ci/gen-badges.py")
|
||||
assert badge_spec is not None and badge_spec.loader is not None
|
||||
gen_badges = importlib.util.module_from_spec(badge_spec)
|
||||
badge_spec.loader.exec_module(gen_badges)
|
||||
|
||||
|
||||
class BenchBadgeTests(unittest.TestCase):
|
||||
def test_declared_suite_matches_rust_benchmarks(self):
|
||||
names = set()
|
||||
for directory in (ROOT / "crates/alkane-gui/src", ROOT / "crates/alkane-artifacts/src"):
|
||||
for path in directory.rglob("*.rs"):
|
||||
names.update(re.findall(
|
||||
r'#\[test\]\s*#\[ignore(?:\s*=\s*"[^"]*")?\]\s*'
|
||||
r'fn (bench_[A-Za-z0-9_]+)\s*\(', path.read_text()))
|
||||
self.assertEqual(names, badge.EXPECTED_BENCHES)
|
||||
|
||||
def test_incomplete_duplicate_and_malformed_results_fail(self):
|
||||
lines = [f"test tests::{name} ... {name}: 10ms/op"
|
||||
for name in sorted(badge.EXPECTED_BENCHES)]
|
||||
values = badge.require_suite(badge.parse_bench("\n".join(lines)))
|
||||
self.assertEqual(len(values), 12)
|
||||
with self.assertRaisesRegex(ValueError, "declared suite"):
|
||||
badge.require_suite(badge.parse_bench("\n".join(lines[:-1])))
|
||||
with self.assertRaisesRegex(ValueError, "duplicate"):
|
||||
badge.parse_bench("\n".join(lines + [lines[0]]))
|
||||
with self.assertRaisesRegex(ValueError, "missing timing"):
|
||||
badge.parse_bench(lines[0].replace("10ms/op", "missing"))
|
||||
|
||||
def test_badge_averages_each_benchmark_improvement(self):
|
||||
current = {"short": 50.0, "long": 900.0}
|
||||
baseline = {"short": 100.0, "long": 1000.0}
|
||||
self.assertEqual(badge.benchmark_delta(current, baseline), 30.0)
|
||||
self.assertAlmostEqual(badge.benchmark_delta(baseline, current), -55.5555556)
|
||||
self.assertIsNone(badge.benchmark_delta(current, {}))
|
||||
self.assertEqual(gen_badges.bench_color(30.0), "brightgreen")
|
||||
self.assertEqual(gen_badges.bench_color(-55.5555556), "orange")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,70 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Exercise benchmark history selection and safe site rendering."""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
import unittest
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from bench_history import bench_badge, previous_measurement, render_html, updated_index
|
||||
|
||||
|
||||
class HistoryTests(unittest.TestCase):
|
||||
def test_cargo_nocapture_benchmark_lines_are_parsed(self):
|
||||
output = (
|
||||
"test tests::bench_verify_artifact ... bench_verify_artifact: 208.302µs\n"
|
||||
"test model::tests::bench_render_cells ... bench_render_cells: "
|
||||
"5000 rows x 10 cols = 8.007185ms/full-render (bytes=13553600)\n"
|
||||
"bench_direct: 12ns/op\n"
|
||||
)
|
||||
self.assertEqual(bench_badge.parse_bench(output), {
|
||||
"bench_verify_artifact": 208_302.0,
|
||||
"bench_render_cells": 8_007_185.0,
|
||||
"bench_direct": 12.0,
|
||||
})
|
||||
|
||||
def test_retry_uses_previous_commit(self):
|
||||
first = "a" * 40
|
||||
second = "b" * 40
|
||||
index = {"schema": 1, "entries": [
|
||||
{"sha": first, "timestamp": "2026-01-01T00:00:00+00:00",
|
||||
"metrics": {"bench_ns_per_op": {"hash": 10.0}}},
|
||||
{"sha": second, "timestamp": "2026-01-02T00:00:00+00:00",
|
||||
"metrics": {"bench_ns_per_op": {"hash": 8.0}}}]}
|
||||
self.assertEqual(previous_measurement(index, second,
|
||||
lambda ancestor, sha: 1 if ancestor == first else None),
|
||||
{"hash": 10.0})
|
||||
updated = updated_index(index, second, {"bench_ns_per_op": {"hash": 7.5}},
|
||||
"2026-01-03T00:00:00+00:00")
|
||||
self.assertEqual(len(updated["entries"]), 2)
|
||||
self.assertEqual(updated["entries"][-1]["metrics"]["bench_ns_per_op"]["hash"], 7.5)
|
||||
|
||||
def test_invalid_measurement_and_sha_rejected(self):
|
||||
with self.assertRaises(ValueError):
|
||||
updated_index({}, "bad", {"bench_ns_per_op": {"hash": 1}}, "now")
|
||||
with self.assertRaises(ValueError):
|
||||
updated_index({}, "a" * 40, {"bench_ns_per_op": {"hash": -1}}, "now")
|
||||
|
||||
def test_baseline_must_match_cpu_class(self):
|
||||
host = {"architecture": "x86_64", "cpu_model": "A", "logical_cpus": 8}
|
||||
other = {"architecture": "x86_64", "cpu_model": "B", "logical_cpus": 8}
|
||||
index = {"entries": [{"sha": "a" * 40, "metrics": {
|
||||
"bench_ns_per_op": {"hash": 10.0}, "bench_host": host}}]}
|
||||
distance = lambda _ancestor, _sha: 1
|
||||
self.assertEqual(previous_measurement(index, "b" * 40, distance, host),
|
||||
{"hash": 10.0})
|
||||
self.assertEqual(previous_measurement(index, "b" * 40, distance, other), {})
|
||||
|
||||
def test_site_escapes_history_content(self):
|
||||
entry = {"sha": "a" * 40, "timestamp": "<script>alert(1)</script>",
|
||||
"metrics": {"bench_ns_per_op": {"hash": 10.0},
|
||||
"bench_host": {"cpu_model": "<script>cpu</script>"}}}
|
||||
page = render_html({"entries": [entry]})
|
||||
self.assertIn("<script>", page)
|
||||
self.assertNotIn("<script>", page)
|
||||
self.assertIn("10.000", page)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Check that queued CI runs do not displace the last completed result."""
|
||||
|
||||
import importlib.util
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch
|
||||
import xml.etree.ElementTree as ET
|
||||
|
||||
path = Path(__file__).with_name("last-attempt-badge.py")
|
||||
spec = importlib.util.spec_from_file_location("last_attempt_badge", path)
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(module)
|
||||
|
||||
|
||||
def runs(_url, _token):
|
||||
return {"workflow_runs": [
|
||||
{"id": 105, "head_branch": "main", "status": "completed", "conclusion": "cancelled"},
|
||||
{"id": 104, "head_branch": "main", "status": "queued", "conclusion": None},
|
||||
{"id": 103, "head_branch": "main", "status": "completed", "conclusion": "failure"},
|
||||
{"id": 102, "head_branch": "main", "status": "completed", "conclusion": "success"},
|
||||
]}
|
||||
|
||||
|
||||
with patch.object(module, "request_json", runs):
|
||||
assert module.latest_completed("https://example.invalid/api/v1", "owner/repo",
|
||||
"release.yml", "main", "token") == (103, "failure")
|
||||
|
||||
svg = module.badge("main", "failure", 103)
|
||||
root = ET.fromstring(svg)
|
||||
assert root.attrib["aria-label"] == "CI main: last completed attempt fail (run 103)"
|
||||
assert b">fail</text>" in svg
|
||||
assert b"#d1242f" in svg
|
||||
assert b">pass</text>" in module.badge("next", "success", 108)
|
||||
print("last completed CI badge: queued run ignored, pass/fail SVGs valid")
|
||||
@@ -1 +1,219 @@
|
||||
// alkane-access
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Bounded, read-only SSH probes for board identification.
|
||||
|
||||
use std::fs;
|
||||
use std::io::{self, Read};
|
||||
use std::net::IpAddr;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::process::{Command, Stdio};
|
||||
use std::thread;
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
const MAX_PROBE_BYTES: usize = 64 * 1024;
|
||||
const PROBE_TIMEOUT: Duration = Duration::from_secs(12);
|
||||
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub enum Probe {
|
||||
KernelRelease,
|
||||
MtdTable,
|
||||
DeviceTreeModel,
|
||||
}
|
||||
|
||||
impl Probe {
|
||||
fn command(self) -> &'static str {
|
||||
match self {
|
||||
Self::KernelRelease => "uname -r",
|
||||
Self::MtdTable => "cat /proc/mtd",
|
||||
Self::DeviceTreeModel => "cat /proc/device-tree/model",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum AccessError {
|
||||
InvalidTarget,
|
||||
InvalidKnownHosts,
|
||||
Timeout,
|
||||
OutputTooLarge,
|
||||
RemoteFailure,
|
||||
Io(io::Error),
|
||||
}
|
||||
|
||||
impl From<io::Error> for AccessError {
|
||||
fn from(error: io::Error) -> Self {
|
||||
Self::Io(error)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct SshTarget {
|
||||
address: IpAddr,
|
||||
port: u16,
|
||||
user: String,
|
||||
known_hosts: PathBuf,
|
||||
}
|
||||
|
||||
impl SshTarget {
|
||||
pub fn new(
|
||||
address: IpAddr,
|
||||
port: u16,
|
||||
user: &str,
|
||||
known_hosts: &Path,
|
||||
) -> Result<Self, AccessError> {
|
||||
if port == 0
|
||||
|| user.is_empty()
|
||||
|| !user
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_alphanumeric() || matches!(byte, b'_' | b'-' | b'.'))
|
||||
{
|
||||
return Err(AccessError::InvalidTarget);
|
||||
}
|
||||
if !known_hosts.is_absolute()
|
||||
|| !fs::metadata(known_hosts).is_ok_and(|metadata| metadata.is_file())
|
||||
{
|
||||
return Err(AccessError::InvalidKnownHosts);
|
||||
}
|
||||
Ok(Self {
|
||||
address,
|
||||
port,
|
||||
user: user.to_owned(),
|
||||
known_hosts: known_hosts.to_owned(),
|
||||
})
|
||||
}
|
||||
|
||||
fn command(&self, probe: Probe) -> Command {
|
||||
let mut command = Command::new("ssh");
|
||||
command
|
||||
.arg("-F")
|
||||
.arg("none")
|
||||
.arg("-o")
|
||||
.arg("BatchMode=yes")
|
||||
.arg("-o")
|
||||
.arg("StrictHostKeyChecking=yes")
|
||||
.arg("-o")
|
||||
.arg("GlobalKnownHostsFile=none")
|
||||
.arg("-o")
|
||||
.arg(format!("UserKnownHostsFile={}", self.known_hosts.display()))
|
||||
.arg("-o")
|
||||
.arg("ConnectTimeout=5")
|
||||
.arg("-o")
|
||||
.arg("ServerAliveInterval=5")
|
||||
.arg("-o")
|
||||
.arg("ServerAliveCountMax=1")
|
||||
.arg("-o")
|
||||
.arg("RequestTTY=no")
|
||||
.arg("-p")
|
||||
.arg(self.port.to_string())
|
||||
.arg(format!("{}@{}", self.user, self.address))
|
||||
.arg(probe.command());
|
||||
command
|
||||
}
|
||||
|
||||
pub fn probe(&self, probe: Probe) -> Result<Vec<u8>, AccessError> {
|
||||
run_bounded(self.command(probe))
|
||||
}
|
||||
}
|
||||
|
||||
fn collect_bounded<R: Read + Send + 'static>(
|
||||
mut reader: R,
|
||||
) -> thread::JoinHandle<Result<Vec<u8>, AccessError>> {
|
||||
thread::spawn(move || {
|
||||
let mut data = Vec::new();
|
||||
let mut chunk = [0_u8; 4096];
|
||||
loop {
|
||||
let count = reader.read(&mut chunk)?;
|
||||
if count == 0 {
|
||||
return Ok(data);
|
||||
}
|
||||
if data.len() + count > MAX_PROBE_BYTES {
|
||||
return Err(AccessError::OutputTooLarge);
|
||||
}
|
||||
data.extend_from_slice(&chunk[..count]);
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn run_bounded(command: Command) -> Result<Vec<u8>, AccessError> {
|
||||
run_bounded_with_timeout(command, PROBE_TIMEOUT)
|
||||
}
|
||||
|
||||
fn run_bounded_with_timeout(
|
||||
mut command: Command,
|
||||
timeout: Duration,
|
||||
) -> Result<Vec<u8>, AccessError> {
|
||||
command
|
||||
.stdin(Stdio::null())
|
||||
.stdout(Stdio::piped())
|
||||
.stderr(Stdio::piped());
|
||||
let mut child = command.spawn()?;
|
||||
let stdout = collect_bounded(child.stdout.take().expect("piped stdout"));
|
||||
let stderr = collect_bounded(child.stderr.take().expect("piped stderr"));
|
||||
let deadline = Instant::now() + timeout;
|
||||
let result = loop {
|
||||
if let Some(status) = child.try_wait()? {
|
||||
break status.success();
|
||||
}
|
||||
if Instant::now() >= deadline {
|
||||
let _ = child.kill();
|
||||
let _ = child.wait();
|
||||
let _ = stdout.join();
|
||||
let _ = stderr.join();
|
||||
return Err(AccessError::Timeout);
|
||||
}
|
||||
thread::sleep(Duration::from_millis(10));
|
||||
};
|
||||
let output = stdout.join().map_err(|_| AccessError::RemoteFailure)??;
|
||||
let error_output = stderr.join().map_err(|_| AccessError::RemoteFailure)??;
|
||||
if !result || !error_output.is_empty() {
|
||||
return Err(AccessError::RemoteFailure);
|
||||
}
|
||||
Ok(output)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn target_rejects_injected_user_and_unknown_host_file() {
|
||||
let address = "127.0.0.1".parse().unwrap();
|
||||
assert!(matches!(
|
||||
SshTarget::new(
|
||||
address,
|
||||
22,
|
||||
"root;id",
|
||||
Path::new("/etc/ssh/ssh_known_hosts")
|
||||
),
|
||||
Err(AccessError::InvalidTarget)
|
||||
));
|
||||
assert!(matches!(
|
||||
SshTarget::new(address, 22, "root", Path::new("relative-known-hosts")),
|
||||
Err(AccessError::InvalidKnownHosts)
|
||||
));
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn bounded_runner_rejects_excess_output_and_failed_command() {
|
||||
let mut success = Command::new("/bin/sh");
|
||||
success.args(["-c", "printf board"]);
|
||||
assert_eq!(run_bounded(success).unwrap(), b"board");
|
||||
let mut overflow = Command::new("/bin/sh");
|
||||
overflow.args(["-c", "head -c 70000 /dev/zero"]);
|
||||
assert!(matches!(
|
||||
run_bounded(overflow),
|
||||
Err(AccessError::OutputTooLarge)
|
||||
));
|
||||
let mut failed = Command::new("/bin/sh");
|
||||
failed.args(["-c", "exit 7"]);
|
||||
assert!(matches!(
|
||||
run_bounded(failed),
|
||||
Err(AccessError::RemoteFailure)
|
||||
));
|
||||
let mut hanging = Command::new("/bin/sleep");
|
||||
hanging.arg("1");
|
||||
assert!(matches!(
|
||||
run_bounded_with_timeout(hanging, Duration::from_millis(20)),
|
||||
Err(AccessError::Timeout)
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,3 +6,5 @@ license.workspace = true
|
||||
|
||||
[dependencies]
|
||||
alkane-core = { path = "../alkane-core" }
|
||||
sha2.workspace = true
|
||||
thiserror.workspace = true
|
||||
|
||||
@@ -1 +1,257 @@
|
||||
// alkane-artifacts
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Verify local firmware artifacts before an install path consumes them.
|
||||
|
||||
use sha2::{Digest, Sha256};
|
||||
use std::collections::HashSet;
|
||||
use std::fs::File;
|
||||
use std::io::{Read, Seek, SeekFrom};
|
||||
use std::path::{Component, Path, PathBuf};
|
||||
use thiserror::Error;
|
||||
|
||||
const SEED: &str = include_str!("../data/manifest-seed.csv");
|
||||
const HEADER: &str = "sha256,size_bytes,path,family,format,applicability";
|
||||
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct ArtifactRecord {
|
||||
pub sha256: String,
|
||||
pub size_bytes: u64,
|
||||
pub path: PathBuf,
|
||||
pub family: String,
|
||||
pub format: String,
|
||||
pub applicability: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Error)]
|
||||
pub enum VerifyError {
|
||||
#[error("artifact I/O: {0}")]
|
||||
Io(#[from] std::io::Error),
|
||||
#[error("manifest line {0} is invalid")]
|
||||
Manifest(usize),
|
||||
#[error("artifact size differs from manifest")]
|
||||
Size,
|
||||
#[error("artifact signature does not match its declared format")]
|
||||
Signature,
|
||||
#[error("artifact SHA-256 differs from manifest")]
|
||||
Digest,
|
||||
#[error("artifact format is not recognized")]
|
||||
UnsupportedFormat,
|
||||
}
|
||||
|
||||
/// A verified, rewound descriptor. Consumers should read this descriptor
|
||||
/// directly instead of reopening the path after verification.
|
||||
pub struct VerifiedArtifact {
|
||||
file: File,
|
||||
record: ArtifactRecord,
|
||||
}
|
||||
|
||||
impl VerifiedArtifact {
|
||||
pub fn record(&self) -> &ArtifactRecord {
|
||||
&self.record
|
||||
}
|
||||
|
||||
pub fn reader(&mut self) -> &mut File {
|
||||
&mut self.file
|
||||
}
|
||||
|
||||
/// Recheck the same descriptor immediately before a guarded write.
|
||||
pub fn revalidate(&mut self) -> Result<(), VerifyError> {
|
||||
verify_open_file(&mut self.file, &self.record)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn seed_manifest() -> Result<Vec<ArtifactRecord>, VerifyError> {
|
||||
parse_manifest(SEED)
|
||||
}
|
||||
|
||||
pub fn parse_manifest(text: &str) -> Result<Vec<ArtifactRecord>, VerifyError> {
|
||||
let mut lines = text.lines();
|
||||
if lines.next() != Some(HEADER) {
|
||||
return Err(VerifyError::Manifest(1));
|
||||
}
|
||||
let mut paths = HashSet::new();
|
||||
let mut records = Vec::new();
|
||||
for (line_number, line) in lines.enumerate() {
|
||||
let line_number = line_number + 2;
|
||||
let parts: Vec<_> = line.splitn(6, ',').collect();
|
||||
if parts.len() != 6 || parts.iter().any(|part| part.trim().is_empty()) {
|
||||
return Err(VerifyError::Manifest(line_number));
|
||||
}
|
||||
let digest = parts[0];
|
||||
let path = PathBuf::from(parts[2]);
|
||||
if digest.len() != 64
|
||||
|| !digest.bytes().all(|byte| byte.is_ascii_hexdigit())
|
||||
|| !path
|
||||
.components()
|
||||
.all(|part| matches!(part, Component::Normal(_)))
|
||||
|| !paths.insert(path.clone())
|
||||
{
|
||||
return Err(VerifyError::Manifest(line_number));
|
||||
}
|
||||
let size_bytes = parts[1]
|
||||
.parse::<u64>()
|
||||
.map_err(|_| VerifyError::Manifest(line_number))?;
|
||||
if size_bytes == 0 {
|
||||
return Err(VerifyError::Manifest(line_number));
|
||||
}
|
||||
records.push(ArtifactRecord {
|
||||
sha256: digest.to_ascii_lowercase(),
|
||||
size_bytes,
|
||||
path,
|
||||
family: parts[3].to_owned(),
|
||||
format: parts[4].to_owned(),
|
||||
applicability: parts[5].to_owned(),
|
||||
});
|
||||
}
|
||||
if records.is_empty() {
|
||||
return Err(VerifyError::Manifest(1));
|
||||
}
|
||||
Ok(records)
|
||||
}
|
||||
|
||||
fn signature_matches(format: &str, first: &[u8]) -> Result<bool, VerifyError> {
|
||||
let prefix: &[u8] = match format {
|
||||
"IMAGEWTY-SD" | "update-zip" | "zip-installer" => b"PK\x03\x04",
|
||||
"ubifs" => b"\x31\x18\x10\x06",
|
||||
"swu" => b"070702",
|
||||
"wm-package-0x9a5ba57c" => b"\x7c\xa5\x5b\x9a",
|
||||
"bmu" => b"\x26\x01",
|
||||
"bin-AES-container" => b"\x3f\x0a\x64\xae",
|
||||
_ => return Err(VerifyError::UnsupportedFormat),
|
||||
};
|
||||
Ok(first.starts_with(prefix))
|
||||
}
|
||||
|
||||
pub fn verify_file(path: &Path, record: &ArtifactRecord) -> Result<VerifiedArtifact, VerifyError> {
|
||||
let mut file = File::open(path)?;
|
||||
verify_open_file(&mut file, record)?;
|
||||
Ok(VerifiedArtifact {
|
||||
file,
|
||||
record: record.clone(),
|
||||
})
|
||||
}
|
||||
|
||||
fn verify_open_file(file: &mut File, record: &ArtifactRecord) -> Result<(), VerifyError> {
|
||||
if file.metadata()?.len() != record.size_bytes {
|
||||
return Err(VerifyError::Size);
|
||||
}
|
||||
file.seek(SeekFrom::Start(0))?;
|
||||
let mut first = [0_u8; 16];
|
||||
let length = file.read(&mut first)?;
|
||||
if !signature_matches(&record.format, &first[..length])? {
|
||||
return Err(VerifyError::Signature);
|
||||
}
|
||||
file.seek(SeekFrom::Start(0))?;
|
||||
let mut hasher = Sha256::new();
|
||||
let mut buffer = [0_u8; 64 * 1024];
|
||||
let mut read_bytes = 0_u64;
|
||||
loop {
|
||||
let length = file.read(&mut buffer)?;
|
||||
if length == 0 {
|
||||
break;
|
||||
}
|
||||
read_bytes += length as u64;
|
||||
hasher.update(&buffer[..length]);
|
||||
}
|
||||
if read_bytes != record.size_bytes {
|
||||
return Err(VerifyError::Size);
|
||||
}
|
||||
let digest = hasher.finalize();
|
||||
let actual: String = digest.iter().map(|byte| format!("{byte:02x}")).collect();
|
||||
if actual != record.sha256 {
|
||||
return Err(VerifyError::Digest);
|
||||
}
|
||||
file.seek(SeekFrom::Start(0))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::io::Write;
|
||||
|
||||
#[test]
|
||||
fn manifest_has_unique_safe_records() {
|
||||
let records = seed_manifest().unwrap();
|
||||
assert_eq!(records.len(), 14);
|
||||
let traversal = format!("{HEADER}\n{},12,../escape,bin,bmu,all\n", "0".repeat(64));
|
||||
assert!(matches!(
|
||||
parse_manifest(&traversal),
|
||||
Err(VerifyError::Manifest(2))
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checks_size_signature_and_digest_before_consumption() {
|
||||
let path =
|
||||
std::env::temp_dir().join(format!("alkane-artifact-test-{}", std::process::id()));
|
||||
let bytes = b"PK\x03\x04example";
|
||||
let mut file = File::create(&path).unwrap();
|
||||
file.write_all(bytes).unwrap();
|
||||
drop(file);
|
||||
let mut record = ArtifactRecord {
|
||||
sha256: Sha256::digest(bytes)
|
||||
.iter()
|
||||
.map(|byte| format!("{byte:02x}"))
|
||||
.collect(),
|
||||
size_bytes: bytes.len() as u64,
|
||||
path: PathBuf::from("fixture.zip"),
|
||||
family: "test".to_owned(),
|
||||
format: "update-zip".to_owned(),
|
||||
applicability: "test".to_owned(),
|
||||
};
|
||||
let mut verified = verify_file(&path, &record).unwrap();
|
||||
verified.revalidate().unwrap();
|
||||
let mut replay = Vec::new();
|
||||
verified.reader().read_to_end(&mut replay).unwrap();
|
||||
assert_eq!(replay, bytes);
|
||||
std::fs::write(&path, b"PK\x03\x04changed").unwrap();
|
||||
assert!(matches!(verified.revalidate(), Err(VerifyError::Digest)));
|
||||
std::fs::write(&path, bytes).unwrap();
|
||||
verified.revalidate().unwrap();
|
||||
record.size_bytes += 1;
|
||||
assert!(matches!(
|
||||
verify_file(&path, &record),
|
||||
Err(VerifyError::Size)
|
||||
));
|
||||
record.size_bytes -= 1;
|
||||
record.format = "ubifs".to_owned();
|
||||
assert!(matches!(
|
||||
verify_file(&path, &record),
|
||||
Err(VerifyError::Signature)
|
||||
));
|
||||
record.format = "update-zip".to_owned();
|
||||
record.sha256 = "0".repeat(64);
|
||||
assert!(matches!(
|
||||
verify_file(&path, &record),
|
||||
Err(VerifyError::Digest)
|
||||
));
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[ignore = "microbenchmark"]
|
||||
fn bench_verify_artifact() {
|
||||
let path =
|
||||
std::env::temp_dir().join(format!("alkane-artifact-bench-{}", std::process::id()));
|
||||
let mut bytes = vec![0x42_u8; 65_536];
|
||||
bytes[..4].copy_from_slice(b"PK\x03\x04");
|
||||
std::fs::write(&path, &bytes).unwrap();
|
||||
let record = ArtifactRecord {
|
||||
sha256: Sha256::digest(&bytes)
|
||||
.iter()
|
||||
.map(|byte| format!("{byte:02x}"))
|
||||
.collect(),
|
||||
size_bytes: bytes.len() as u64,
|
||||
path: PathBuf::from("bench.zip"),
|
||||
family: "test".to_owned(),
|
||||
format: "update-zip".to_owned(),
|
||||
applicability: "test".to_owned(),
|
||||
};
|
||||
let started = std::time::Instant::now();
|
||||
for _ in 0..100 {
|
||||
std::hint::black_box(verify_file(&path, &record).unwrap());
|
||||
}
|
||||
println!("bench_verify_artifact: {:?}", started.elapsed() / 100);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,3 +6,4 @@ license.workspace = true
|
||||
|
||||
[dependencies]
|
||||
alkane-core = { path = "../alkane-core" }
|
||||
alkane-artifacts = { path = "../alkane-artifacts" }
|
||||
|
||||
@@ -1,4 +1,31 @@
|
||||
//! Headless driver over the same engine the GUI uses.
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Headless entry point for read-only artifact verification.
|
||||
|
||||
use alkane_artifacts::{seed_manifest, verify_file};
|
||||
use std::path::Path;
|
||||
|
||||
fn run() -> Result<(), Box<dyn std::error::Error>> {
|
||||
let args: Vec<_> = std::env::args().collect();
|
||||
if args.len() != 4 || args[1] != "verify-artifact" {
|
||||
return Err("usage: alkane-cli verify-artifact <manifest-path> <local-file>".into());
|
||||
}
|
||||
let record = seed_manifest()?
|
||||
.into_iter()
|
||||
.find(|item| item.path == Path::new(&args[2]))
|
||||
.ok_or("artifact path is absent from the seed manifest")?;
|
||||
let verified = verify_file(Path::new(&args[3]), &record)?;
|
||||
println!(
|
||||
"verified {} {} {} bytes",
|
||||
verified.record().family,
|
||||
verified.record().format,
|
||||
verified.record().size_bytes
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() {
|
||||
println!("alkane-toolkit-cli: scaffold");
|
||||
if let Err(error) = run() {
|
||||
eprintln!("artifact verification failed: {error}");
|
||||
std::process::exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,3 +6,7 @@ license.workspace = true
|
||||
|
||||
[dependencies]
|
||||
alkane-core = { path = "../alkane-core" }
|
||||
alkane-artifacts = { path = "../alkane-artifacts" }
|
||||
sha2.workspace = true
|
||||
thiserror.workspace = true
|
||||
tempfile = "3"
|
||||
|
||||
@@ -1 +1,446 @@
|
||||
// alkane-flash
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Guarded write sequence for a verified artifact and an SDK partition plan.
|
||||
//! Board transport adapters must supply serial, recovery and readback evidence.
|
||||
|
||||
use alkane_artifacts::VerifiedArtifact;
|
||||
use sha2::{Digest, Sha256};
|
||||
use std::io::{Read, Seek, SeekFrom, Write};
|
||||
use thiserror::Error;
|
||||
|
||||
pub struct PartitionSpec {
|
||||
pub name: String,
|
||||
pub capacity_bytes: u64,
|
||||
pub secure: bool,
|
||||
pub boot_critical: bool,
|
||||
}
|
||||
|
||||
pub struct BackupEvidence {
|
||||
pub location: String,
|
||||
pub bytes: u64,
|
||||
pub sha256: [u8; 32],
|
||||
}
|
||||
|
||||
pub struct WriteReceipt {
|
||||
pub partition: String,
|
||||
pub backup: BackupEvidence,
|
||||
pub image_sha256: [u8; 32],
|
||||
}
|
||||
|
||||
pub trait Writer {
|
||||
type Error: std::fmt::Display;
|
||||
|
||||
fn channel_id(&self) -> &str;
|
||||
fn serial_console_attached(&mut self) -> Result<bool, Self::Error>;
|
||||
fn recovery_image_ready(&mut self, partition: &PartitionSpec) -> Result<bool, Self::Error>;
|
||||
fn backup(&mut self, partition: &PartitionSpec) -> Result<BackupEvidence, Self::Error>;
|
||||
fn write(
|
||||
&mut self,
|
||||
partition: &PartitionSpec,
|
||||
image: &mut dyn Read,
|
||||
image_size: u64,
|
||||
) -> Result<(), Self::Error>;
|
||||
}
|
||||
|
||||
pub trait IndependentReadback {
|
||||
type Error: std::fmt::Display;
|
||||
|
||||
fn channel_id(&self) -> &str;
|
||||
fn sha256(&mut self, partition: &PartitionSpec, length: u64) -> Result<[u8; 32], Self::Error>;
|
||||
}
|
||||
|
||||
#[derive(Debug, Error, Eq, PartialEq)]
|
||||
pub enum FlashError {
|
||||
#[error("secure partition write refused")]
|
||||
SecurePartition,
|
||||
#[error("image exceeds partition capacity")]
|
||||
ImageTooLarge,
|
||||
#[error("boot-critical write requires an attached serial console")]
|
||||
SerialRequired,
|
||||
#[error("boot-critical write requires verified recovery media")]
|
||||
RecoveryRequired,
|
||||
#[error("readback must use an independent channel")]
|
||||
SameChannel,
|
||||
#[error("complete backup evidence is missing")]
|
||||
BackupIncomplete,
|
||||
#[error("post-write readback differs from the image")]
|
||||
ReadbackMismatch,
|
||||
#[error("verified image has an invalid digest")]
|
||||
InvalidDigest,
|
||||
#[error("image changed since verification")]
|
||||
ArtifactChanged,
|
||||
#[error("writer did not consume the complete image")]
|
||||
IncompleteWrite,
|
||||
#[error("write transport: {0}")]
|
||||
Write(String),
|
||||
#[error("readback transport: {0}")]
|
||||
Readback(String),
|
||||
#[error("artifact I/O: {0}")]
|
||||
ArtifactIo(String),
|
||||
}
|
||||
|
||||
fn digest_bytes(hex: &str) -> Result<[u8; 32], FlashError> {
|
||||
if hex.len() != 64 {
|
||||
return Err(FlashError::InvalidDigest);
|
||||
}
|
||||
let mut result = [0_u8; 32];
|
||||
for (index, pair) in hex.as_bytes().chunks_exact(2).enumerate() {
|
||||
let text = std::str::from_utf8(pair).map_err(|_| FlashError::InvalidDigest)?;
|
||||
result[index] = u8::from_str_radix(text, 16).map_err(|_| FlashError::InvalidDigest)?;
|
||||
}
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
fn stage_verified_artifact(
|
||||
artifact: &mut VerifiedArtifact,
|
||||
size: u64,
|
||||
expected: [u8; 32],
|
||||
) -> Result<std::fs::File, FlashError> {
|
||||
let mut staged = tempfile::tempfile().map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
artifact
|
||||
.reader()
|
||||
.seek(SeekFrom::Start(0))
|
||||
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
let mut source = DigestReader {
|
||||
inner: artifact.reader(),
|
||||
remaining: size,
|
||||
digest: Sha256::new(),
|
||||
};
|
||||
std::io::copy(&mut source, &mut staged).map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
if source.remaining != 0 || <[u8; 32]>::from(source.digest.finalize()) != expected {
|
||||
return Err(FlashError::ArtifactChanged);
|
||||
}
|
||||
staged
|
||||
.flush()
|
||||
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
staged
|
||||
.seek(SeekFrom::Start(0))
|
||||
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
Ok(staged)
|
||||
}
|
||||
|
||||
struct DigestReader<'a> {
|
||||
inner: &'a mut dyn Read,
|
||||
remaining: u64,
|
||||
digest: Sha256,
|
||||
}
|
||||
|
||||
impl Read for DigestReader<'_> {
|
||||
fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
|
||||
let limit = buffer
|
||||
.len()
|
||||
.min(usize::try_from(self.remaining).unwrap_or(usize::MAX));
|
||||
let length = self.inner.read(&mut buffer[..limit])?;
|
||||
self.remaining -= length as u64;
|
||||
self.digest.update(&buffer[..length]);
|
||||
Ok(length)
|
||||
}
|
||||
}
|
||||
|
||||
/// Stop before reboot. The caller must still prove live boot and persistence.
|
||||
pub fn write_verified<W: Writer, R: IndependentReadback>(
|
||||
partition: &PartitionSpec,
|
||||
artifact: &mut VerifiedArtifact,
|
||||
writer: &mut W,
|
||||
readback: &mut R,
|
||||
) -> Result<WriteReceipt, FlashError> {
|
||||
if partition.secure {
|
||||
return Err(FlashError::SecurePartition);
|
||||
}
|
||||
let size = artifact.record().size_bytes;
|
||||
if size == 0 || partition.capacity_bytes == 0 || size > partition.capacity_bytes {
|
||||
return Err(FlashError::ImageTooLarge);
|
||||
}
|
||||
if writer.channel_id().is_empty()
|
||||
|| readback.channel_id().is_empty()
|
||||
|| writer.channel_id() == readback.channel_id()
|
||||
{
|
||||
return Err(FlashError::SameChannel);
|
||||
}
|
||||
if partition.boot_critical {
|
||||
if !writer
|
||||
.serial_console_attached()
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?
|
||||
{
|
||||
return Err(FlashError::SerialRequired);
|
||||
}
|
||||
if !writer
|
||||
.recovery_image_ready(partition)
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?
|
||||
{
|
||||
return Err(FlashError::RecoveryRequired);
|
||||
}
|
||||
}
|
||||
artifact
|
||||
.revalidate()
|
||||
.map_err(|_| FlashError::ArtifactChanged)?;
|
||||
let expected = digest_bytes(&artifact.record().sha256)?;
|
||||
// The source path may change while backup or transport I/O runs. Copy and
|
||||
// verify it before any device write; the anonymous file is removed on drop.
|
||||
let mut staged = stage_verified_artifact(artifact, size, expected)?;
|
||||
let backup = writer
|
||||
.backup(partition)
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?;
|
||||
if backup.location.is_empty()
|
||||
|| backup.bytes != partition.capacity_bytes
|
||||
|| backup.sha256 == [0; 32]
|
||||
{
|
||||
return Err(FlashError::BackupIncomplete);
|
||||
}
|
||||
let mut stream = DigestReader {
|
||||
inner: &mut staged,
|
||||
remaining: size,
|
||||
digest: Sha256::new(),
|
||||
};
|
||||
writer
|
||||
.write(partition, &mut stream, size)
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?;
|
||||
if stream.remaining != 0 {
|
||||
return Err(FlashError::IncompleteWrite);
|
||||
}
|
||||
let written_digest: [u8; 32] = stream.digest.finalize().into();
|
||||
if written_digest != expected {
|
||||
return Err(FlashError::ArtifactChanged);
|
||||
}
|
||||
let actual = readback
|
||||
.sha256(partition, size)
|
||||
.map_err(|e| FlashError::Readback(e.to_string()))?;
|
||||
if actual != expected {
|
||||
return Err(FlashError::ReadbackMismatch);
|
||||
}
|
||||
Ok(WriteReceipt {
|
||||
partition: partition.name.clone(),
|
||||
backup,
|
||||
image_sha256: expected,
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use alkane_artifacts::{verify_file, ArtifactRecord};
|
||||
use std::path::PathBuf;
|
||||
|
||||
const SHA: &str = "bf7d458495ed067341c7148cd3d30e6d383a2113b2cfb37de12959e057a52528";
|
||||
const IMAGE: &[u8] = b"PK\x03\x04payload";
|
||||
|
||||
struct MockWriter {
|
||||
serial: bool,
|
||||
recovery: bool,
|
||||
backup_bytes: u64,
|
||||
max_read: Option<u64>,
|
||||
writes: usize,
|
||||
contents: Vec<u8>,
|
||||
mutate_source_on_write: Option<PathBuf>,
|
||||
}
|
||||
|
||||
impl Writer for MockWriter {
|
||||
type Error = &'static str;
|
||||
|
||||
fn channel_id(&self) -> &str {
|
||||
"ssh"
|
||||
}
|
||||
fn serial_console_attached(&mut self) -> Result<bool, Self::Error> {
|
||||
Ok(self.serial)
|
||||
}
|
||||
fn recovery_image_ready(&mut self, _: &PartitionSpec) -> Result<bool, Self::Error> {
|
||||
Ok(self.recovery)
|
||||
}
|
||||
fn backup(&mut self, _: &PartitionSpec) -> Result<BackupEvidence, Self::Error> {
|
||||
Ok(BackupEvidence {
|
||||
location: "recovery/partition.img".to_owned(),
|
||||
bytes: self.backup_bytes,
|
||||
sha256: [1; 32],
|
||||
})
|
||||
}
|
||||
fn write(
|
||||
&mut self,
|
||||
_: &PartitionSpec,
|
||||
image: &mut dyn Read,
|
||||
_: u64,
|
||||
) -> Result<(), Self::Error> {
|
||||
self.writes += 1;
|
||||
if let Some(path) = &self.mutate_source_on_write {
|
||||
std::fs::write(path, b"PK\x03\x04changed").map_err(|_| "mutation failed")?;
|
||||
}
|
||||
if let Some(limit) = self.max_read {
|
||||
image
|
||||
.take(limit)
|
||||
.read_to_end(&mut self.contents)
|
||||
.map_err(|_| "read failed")?;
|
||||
} else {
|
||||
image
|
||||
.read_to_end(&mut self.contents)
|
||||
.map_err(|_| "read failed")?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
struct MockReadback {
|
||||
channel: &'static str,
|
||||
digest: [u8; 32],
|
||||
}
|
||||
|
||||
impl IndependentReadback for MockReadback {
|
||||
type Error = &'static str;
|
||||
|
||||
fn channel_id(&self) -> &str {
|
||||
self.channel
|
||||
}
|
||||
fn sha256(&mut self, _: &PartitionSpec, _: u64) -> Result<[u8; 32], Self::Error> {
|
||||
Ok(self.digest)
|
||||
}
|
||||
}
|
||||
|
||||
fn artifact(suffix: &str) -> (PathBuf, VerifiedArtifact) {
|
||||
let path =
|
||||
std::env::temp_dir().join(format!("alkane-flash-test-{}-{suffix}", std::process::id()));
|
||||
std::fs::write(&path, IMAGE).unwrap();
|
||||
let record = ArtifactRecord {
|
||||
sha256: SHA.to_owned(),
|
||||
size_bytes: IMAGE.len() as u64,
|
||||
path: PathBuf::from("fixture.zip"),
|
||||
family: "test".to_owned(),
|
||||
format: "update-zip".to_owned(),
|
||||
applicability: "test".to_owned(),
|
||||
};
|
||||
let verified = verify_file(&path, &record).unwrap();
|
||||
(path, verified)
|
||||
}
|
||||
|
||||
fn writer() -> MockWriter {
|
||||
MockWriter {
|
||||
serial: true,
|
||||
recovery: true,
|
||||
backup_bytes: 4096,
|
||||
max_read: None,
|
||||
writes: 0,
|
||||
contents: Vec::new(),
|
||||
mutate_source_on_write: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn partition() -> PartitionSpec {
|
||||
PartitionSpec {
|
||||
name: "rootfs".to_owned(),
|
||||
capacity_bytes: 4096,
|
||||
secure: false,
|
||||
boot_critical: true,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn refuses_secure_and_unrecoverable_writes_before_device_mutation() {
|
||||
let (path, mut image) = artifact("refusals");
|
||||
let mut target = partition();
|
||||
let mut writer = writer();
|
||||
let mut readback = MockReadback {
|
||||
channel: "serial",
|
||||
digest: digest_bytes(SHA).unwrap(),
|
||||
};
|
||||
target.secure = true;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::SecurePartition)
|
||||
));
|
||||
target.secure = false;
|
||||
target.capacity_bytes = 1;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::ImageTooLarge)
|
||||
));
|
||||
target.capacity_bytes = 4096;
|
||||
writer.serial = false;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::SerialRequired)
|
||||
));
|
||||
writer.serial = true;
|
||||
writer.recovery = false;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::RecoveryRequired)
|
||||
));
|
||||
writer.recovery = true;
|
||||
writer.backup_bytes = 1;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::BackupIncomplete)
|
||||
));
|
||||
assert_eq!(writer.writes, 0);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn requires_independent_matching_readback() {
|
||||
let (path, mut image) = artifact("readback");
|
||||
let target = partition();
|
||||
let mut writer = writer();
|
||||
let mut readback = MockReadback {
|
||||
channel: "ssh",
|
||||
digest: [0; 32],
|
||||
};
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::SameChannel)
|
||||
));
|
||||
assert_eq!(writer.writes, 0);
|
||||
readback.channel = "serial";
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::ReadbackMismatch)
|
||||
));
|
||||
assert_eq!(writer.writes, 1);
|
||||
assert_eq!(writer.contents, IMAGE);
|
||||
writer.contents.clear();
|
||||
readback.digest = digest_bytes(SHA).unwrap();
|
||||
let receipt = write_verified(&target, &mut image, &mut writer, &mut readback).unwrap();
|
||||
assert_eq!(receipt.image_sha256, readback.digest);
|
||||
assert_eq!(receipt.backup.bytes, 4096);
|
||||
assert_eq!(writer.writes, 2);
|
||||
assert_eq!(writer.contents, IMAGE);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn refuses_changed_or_partially_consumed_artifacts() {
|
||||
let (path, mut image) = artifact("changed");
|
||||
let target = partition();
|
||||
let mut writer = writer();
|
||||
let mut readback = MockReadback {
|
||||
channel: "serial",
|
||||
digest: digest_bytes(SHA).unwrap(),
|
||||
};
|
||||
std::fs::write(&path, b"PK\x03\x04changed").unwrap();
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::ArtifactChanged)
|
||||
));
|
||||
assert_eq!(writer.writes, 0);
|
||||
|
||||
std::fs::write(&path, IMAGE).unwrap();
|
||||
writer.max_read = Some(4);
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::IncompleteWrite)
|
||||
));
|
||||
assert_eq!(writer.writes, 1);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_verified_snapshot_when_source_changes_during_transport() {
|
||||
let (path, mut image) = artifact("mutated-during-write");
|
||||
let mut writer = writer();
|
||||
writer.mutate_source_on_write = Some(path.clone());
|
||||
let mut readback = MockReadback {
|
||||
channel: "serial",
|
||||
digest: digest_bytes(SHA).unwrap(),
|
||||
};
|
||||
let receipt = write_verified(&partition(), &mut image, &mut writer, &mut readback).unwrap();
|
||||
assert_eq!(receipt.image_sha256, digest_bytes(SHA).unwrap());
|
||||
assert_eq!(writer.contents, IMAGE);
|
||||
assert_eq!(std::fs::read(&path).unwrap(), b"PK\x03\x04changed");
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,5 +14,16 @@ alkane-discovery = { path = "../alkane-discovery" }
|
||||
# vendored + patched wx-rs (see vendor/wx-rs/patches/)
|
||||
wx-rs = { path = "../../thirdparty/wx-rs/wx-rs-0.2.0-patched" }
|
||||
asic-rs = "0.8.1"
|
||||
measurements = "0.11"
|
||||
tokio = { version = "1", features = ["rt"] }
|
||||
futures-util = "0.3"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
# WhatsMiner :4028 token-auth access check (round 12 #8b) -- same crates the
|
||||
# vendored asic-rs whatsminer backend uses, so no new versions enter the lock.
|
||||
md5crypt = "1"
|
||||
sha2 = "0.10"
|
||||
aes = "0.8"
|
||||
ecb = "0.1"
|
||||
base64 = "0.21"
|
||||
hex = "0.4"
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--!Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2026 Fonticons, Inc.--><path d="M434.8 54.1C446.7 62.7 451.1 78.3 445.7 91.9L367.3 288L512 288C525.5 288 537.5 296.4 542.1 309.1C546.7 321.8 542.8 336 532.5 344.6L244.5 584.6C233.2 594 217.1 594.5 205.2 585.9C193.3 577.3 188.9 561.7 194.3 548.1L272.7 352L128 352C114.5 352 102.5 343.6 97.9 330.9C93.3 318.2 97.2 304 107.5 295.4L395.5 55.4C406.8 46 422.9 45.5 434.8 54.1z"/></svg>
|
||||
|
After Width: | Height: | Size: 569 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path fill="currentColor" d="M240 8L48 296h112L128 504 336 216H224L272 8z"/></svg>
|
||||
|
After Width: | Height: | Size: 145 B |
@@ -0,0 +1,29 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)" >
|
||||
<path d="M2152 4645 c-35 -8 -95 -28 -133 -46 l-70 -32 39 -41 c109 -115 121
|
||||
-180 41 -222 -48 -24 -74 -11 -168 85 -225 229 -555 240 -774 25 l-59 -57 57
|
||||
-22 c103 -38 134 -107 76 -166 -36 -36 -54 -36 -145 -3 -290 107 -608 -44
|
||||
-712 -339 -13 -36 -13 -39 4 -32 147 57 237 37 237 -54 0 -56 -26 -78 -115
|
||||
-101 -479 -123 -584 -723 -175 -995 92 -62 102 -71 105 -100 4 -40 -1 -56 -25
|
||||
-80 -34 -35 -81 -33 -146 5 -28 17 -53 29 -55 27 -2 -2 14 -38 35 -80 114
|
||||
-227 341 -383 586 -404 l70 -5 1 103 c4 397 280 752 674 870 70 21 101 23 447
|
||||
28 l373 6 25 26 c19 18 28 42 35 85 15 107 57 173 141 219 54 30 55 30 234 33
|
||||
108 2 191 -1 207 -7 60 -23 72 -111 21 -151 -23 -18 -41 -20 -185 -20 -200 0
|
||||
-238 -16 -238 -98 0 -66 -30 -134 -84 -188 -82 -81 -98 -84 -482 -84 -348 0
|
||||
-405 -6 -526 -55 -355 -144 -547 -560 -421 -912 156 -434 650 -621 1049 -398
|
||||
60 34 224 176 224 195 0 4 -17 19 -38 33 -109 72 -138 132 -92 190 43 54 75
|
||||
48 192 -36 291 -208 673 -260 1012 -136 205 74 390 218 518 399 71 102 72 106
|
||||
48 140 -37 52 -90 177 -90 213 0 68 62 109 126 82 25 -10 36 -26 58 -81 153
|
||||
-385 618 -488 905 -201 197 197 213 494 39 725 -38 52 -148 142 -172 142 -6 0
|
||||
-20 -33 -30 -72 -33 -128 -107 -172 -175 -104 -31 32 -31 62 3 171 114 371
|
||||
-43 798 -372 1015 -71 47 -198 108 -206 99 -3 -2 13 -40 35 -84 46 -92 43
|
||||
-132 -12 -160 -64 -34 -95 -17 -149 81 -251 454 -793 618 -1249 378 -99 -52
|
||||
-140 -57 -176 -18 -43 46 -30 109 28 144 l31 19 -39 17 c-102 42 -247 54 -363
|
||||
29z"/>
|
||||
<path d="M4064 2007 c-184 -270 -531 -485 -854 -529 -49 -7 -90 -16 -90 -20 0
|
||||
-19 163 -171 228 -213 494 -318 1255 -101 1387 395 15 55 18 199 6 254 l-6 30
|
||||
-155 1 c-119 1 -168 6 -210 19 -67 22 -184 79 -226 111 l-31 24 -49 -72z"/>
|
||||
<path d="M2431 1509 c-51 -58 -53 -62 -47 -103 13 -83 97 -179 179 -205 18 -5
|
||||
62 -12 98 -16 138 -13 125 -2 531 -464 231 -265 244 -275 305 -259 63 17 68
|
||||
37 68 276 l0 214 -80 27 c-237 80 -440 241 -552 441 -23 41 -33 50 -56 50 -49
|
||||
0 -179 30 -284 66 -55 19 -103 34 -105 34 -2 0 -28 -27 -57 -61z"/>
|
||||
</g></svg>
|
||||
|
After Width: | Height: | Size: 2.0 KiB |
@@ -0,0 +1,38 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)" >
|
||||
<path d="M1970 5109 c-158 -18 -233 -52 -290 -130 -63 -88 -40 -168 95 -329
|
||||
290 -345 492 -728 595 -1130 7 -25 34 -86 61 -136 l49 -91 108 -6 c76 -3 130
|
||||
-12 187 -31 44 -14 83 -22 87 -18 13 13 87 322 112 470 126 749 -33 1218 -462
|
||||
1362 -134 45 -353 60 -542 39z"/>
|
||||
<path d="M3615 4886 c-82 -30 -119 -107 -130 -271 -29 -409 -151 -830 -337
|
||||
-1160 -41 -74 -72 -146 -94 -220 l-33 -110 34 -27 c45 -38 120 -139 157 -213
|
||||
17 -33 32 -61 33 -63 10 -11 325 187 480 303 704 524 836 1036 386 1499 -221
|
||||
228 -372 307 -496 262z"/>
|
||||
<path d="M975 4370 c-226 -36 -431 -174 -638 -430 -97 -120 -131 -220 -107
|
||||
-310 24 -90 105 -132 280 -145 435 -32 872 -164 1211 -366 30 -17 103 -47 163
|
||||
-64 l108 -33 29 33 c42 48 130 113 209 154 l70 37 -56 99 c-246 438 -574 799
|
||||
-857 943 -131 67 -298 101 -412 82z"/>
|
||||
<path d="M4795 3451 c-23 -10 -86 -56 -140 -103 -326 -277 -690 -475 -1066
|
||||
-579 -76 -21 -144 -48 -205 -82 l-91 -51 -6 -105 c-3 -75 -13 -130 -31 -186
|
||||
-14 -44 -22 -83 -18 -87 10 -10 261 -74 382 -97 794 -154 1301 2 1450 447 74
|
||||
222 63 625 -20 756 -63 99 -158 131 -255 87z"/>
|
||||
<path d="M2443 3095 c-206 -45 -374 -215 -418 -422 -82 -385 263 -730 648
|
||||
-648 209 44 378 213 423 424 81 385 -268 730 -653 646z m152 -179 c59 -25 75
|
||||
-97 31 -141 -24 -24 -35 -28 -111 -40 -54 -9 -121 -76 -130 -130 -12 -76 -16
|
||||
-87 -40 -111 -26 -26 -72 -32 -107 -13 -49 26 -54 133 -10 232 45 101 163 191
|
||||
274 207 29 4 54 8 56 9 1 0 18 -5 37 -13z"/>
|
||||
<path d="M767 3009 c-562 -63 -820 -407 -758 -1013 20 -185 49 -255 133 -316
|
||||
87 -64 167 -40 333 100 329 276 698 475 1070 575 65 18 132 45 192 79 l93 51
|
||||
0 73 c0 79 21 199 46 258 20 47 20 47 -116 83 -359 95 -742 138 -993 110z"/>
|
||||
<path d="M1770 2244 c-141 -81 -339 -216 -449 -304 -716 -578 -764 -1101 -146
|
||||
-1599 106 -85 171 -115 255 -115 139 -2 184 64 206 302 43 463 178 899 372
|
||||
1206 14 23 40 90 58 151 l33 109 -40 34 c-48 41 -117 137 -155 215 -16 31 -31
|
||||
57 -34 56 -3 0 -48 -25 -100 -55z"/>
|
||||
<path d="M3098 2066 c-35 -44 -138 -121 -213 -158 -33 -17 -61 -32 -63 -33
|
||||
-12 -10 203 -350 312 -494 527 -695 1026 -820 1490 -372 193 187 268 305 270
|
||||
421 1 129 -67 183 -251 201 -210 20 -292 32 -408 55 -297 62 -591 172 -836
|
||||
314 -36 21 -106 50 -155 64 -50 14 -97 28 -105 31 -8 3 -25 -9 -41 -29z"/>
|
||||
<path d="M2256 1882 c-25 -41 -108 -428 -131 -612 -18 -143 -21 -439 -5 -550
|
||||
74 -535 419 -776 1015 -710 174 19 246 50 305 131 63 87 39 170 -92 324 -277
|
||||
326 -474 689 -579 1066 -21 74 -49 146 -82 207 l-51 92 -73 0 c-79 0 -200 21
|
||||
-257 45 -41 17 -43 18 -50 7z"/>
|
||||
</g></svg>
|
||||
|
After Width: | Height: | Size: 2.5 KiB |
@@ -0,0 +1 @@
|
||||
<svg version="1.0" xmlns="http://www.w3.org/2000/svg" width="511.104248pt" height="512.144915pt" viewBox="0 0 511.104248 512.144915" preserveAspectRatio="xMidYMid meet"><g transform="translate(-0.500000,511.997478) scale(0.100000,-0.100000)" fill="currentColor" stroke="none"><path d="M82 5103 c-52 -25 -77 -69 -77 -133 0 -41 6 -63 22 -86 49 -68 -31 -64 1237 -64 l1146 0 0 -150 0 -150 -323 0 c-292 0 -332 -2 -403 -20 -201 -52 -370 -228 -414 -432 -8 -34 -11 -94 -8 -155 5 -90 12 -119 52 -214 6 -14 -9 -17 -121 -22 -142 -7 -205 -22 -304 -73 -123 -65 -229 -192 -272 -329 -33 -106 -30 -264 7 -360 15 -38 30 -77 32 -85 4 -12 -9 -20 -49 -33 -76 -24 -163 -83 -228 -156 -160 -176 -193 -424 -86 -638 61 -123 195 -242 315 -280 40 -13 52 -21 48 -33 -2 -8 -17 -46 -32 -85 -38 -95 -41 -253 -7 -360 56 -178 206 -323 393 -380 32 -9 108 -19 182 -22 l126 -6 -25 -66 c-31 -81 -42 -233 -23 -319 45 -210 221 -387 433 -437 94 -22 1622 -22 1716 0 108 26 188 71 272 155 126 125 176 255 167 437 -5 90 -12 119 -52 214 -6 14 9 17 122 22 147 6 246 33 337 92 110 70 199 186 238 310 33 106 30 264 -7 360 -15 39 -30 77 -32 85 -4 12 9 20 49 33 211 67 377 303 377 537 0 233 -167 470 -378 537 -40 13 -52 21 -48 33 2 8 17 47 32 85 37 96 40 254 7 360 -39 122 -130 241 -240 311 -89 58 -188 85 -335 91 -113 5 -128 8 -122 22 40 95 47 124 52 214 6 119 -7 184 -55 287 -46 97 -157 210 -254 257 -117 58 -159 63 -516 63 l-323 0 0 150 0 150 618 0 617 0 210 -211 c116 -116 227 -219 247 -230 122 -63 256 59 207 187 -5 16 -60 79 -121 141 l-112 113 313 0 c346 0 360 2 404 64 31 43 31 129 0 172 -50 70 173 64 -2535 64 -2230 0 -2446 -2 -2476 -17z m3337 -918 c94 -52 141 -134 141 -244 -1 -102 -60 -192 -155 -237 l-50 -24 -795 0 -795 0 -50 24 c-61 28 -116 87 -140 149 -26 70 -17 172 21 235 31 49 104 105 158 121 18 6 363 9 821 8 l790 -2 54 -30z m649 -834 c95 -43 162 -147 162 -251 0 -66 -30 -131 -85 -187 -84 -83 -84 -83 -593 -83 l-434 0 -55 50 c-281 257 -719 257 -1005 0 l-57 -51 -453 3 c-452 3 -453 3 -500 26 -92 45 -158 151 -158 252 0 119 99 235 221 259 24 5 688 8 1474 8 l1430 -2 53 -24z m-1317 -623 c130 -64 224 -184 249 -317 5 -29 10 -98 10 -151 0 -53 -5 -122 -10 -151 -25 -133 -119 -253 -249 -317 -73 -36 -77 -37 -191 -37 -114 0 -118 1 -191 37 -125 62 -210 164 -244 293 -20 79 -20 271 0 350 39 149 147 263 300 318 38 13 74 17 151 15 93 -3 107 -6 175 -40z m-924 -235 c-16 -51 -16 -415 0 -465 l11 -38 -547 0 -548 0 -62 31 c-87 43 -138 117 -148 213 -11 110 44 211 145 263 l64 33 548 0 548 0 -11 -37z m2580 24 c60 -22 117 -72 148 -128 26 -46 30 -64 30 -129 0 -65 -4 -83 -30 -129 -31 -56 -88 -106 -148 -128 -23 -8 -187 -12 -578 -12 l-546 -1 13 68 c17 86 17 318 0 405 l-13 67 546 -1 c391 0 555 -4 578 -12z m-2349 -878 c286 -256 725 -255 1006 1 l55 51 453 -3 c452 -3 453 -3 500 -26 90 -44 158 -151 158 -247 0 -99 -69 -204 -162 -246 l-53 -24 -1455 0 -1455 0 -53 24 c-95 43 -162 147 -162 251 0 66 30 131 85 187 83 82 79 81 588 82 l439 1 56 -51z m1342 -820 c97 -43 160 -138 160 -240 0 -111 -47 -192 -141 -244 l-54 -30 -783 -3 c-518 -2 -796 1 -822 8 -59 16 -131 70 -164 122 -38 63 -47 165 -21 235 24 62 79 121 140 149 l50 24 795 0 c778 0 796 -1 840 -21z"/></g></svg>
|
||||
|
After Width: | Height: | Size: 3.0 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Pro 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M128 192l128 0 0-64c0-35.3-28.7-64-64-64s-64 28.7-64 64l0 64zm-64 0l0-64C64 57.3 121.3 0 192 0S320 57.3 320 128l0 64c35.3 0 64 28.7 64 64l0 192c0 35.3-28.7 64-64 64L64 512c-35.3 0-64-28.7-64-64L0 256c0-35.3 28.7-64 64-64zm256 64l-256 0 0 192 256 0 0-192z"/></svg>
|
||||
|
After Width: | Height: | Size: 522 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--!Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2026 Fonticons, Inc.--><path d="M240 88C240 74.7 229.3 64 216 64C202.7 64 192 74.7 192 88L192 128C156.7 128 128 156.7 128 192L88 192C74.7 192 64 202.7 64 216C64 229.3 74.7 240 88 240L128 240L128 296L88 296C74.7 296 64 306.7 64 320C64 333.3 74.7 344 88 344L128 344L128 400L88 400C74.7 400 64 410.7 64 424C64 437.3 74.7 448 88 448L128 448C128 483.3 156.7 512 192 512L192 552C192 565.3 202.7 576 216 576C229.3 576 240 565.3 240 552L240 512L296 512L296 552C296 565.3 306.7 576 320 576C333.3 576 344 565.3 344 552L344 512L400 512L400 552C400 565.3 410.7 576 424 576C437.3 576 448 565.3 448 552L448 512C483.3 512 512 483.3 512 448L552 448C565.3 448 576 437.3 576 424C576 410.7 565.3 400 552 400L512 400L512 344L552 344C565.3 344 576 333.3 576 320C576 306.7 565.3 296 552 296L512 296L512 240L552 240C565.3 240 576 229.3 576 216C576 202.7 565.3 192 552 192L512 192C512 156.7 483.3 128 448 128L448 88C448 74.7 437.3 64 424 64C410.7 64 400 74.7 400 88L400 128L344 128L344 88C344 74.7 333.3 64 320 64C306.7 64 296 74.7 296 88L296 128L240 128L240 88zM224 192L416 192C433.7 192 448 206.3 448 224L448 416C448 433.7 433.7 448 416 448L224 448C206.3 448 192 433.7 192 416L192 224C192 206.3 206.3 192 224 192zM240 240L240 400L400 400L400 240L240 240z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.4 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--!Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2026 Fonticons, Inc.--><path d="M181.5 261.1L194.4 267.5C200.3 270.5 206.8 272 213.5 272C237 272 256.1 252.9 256.1 229.4L256.1 208C256.1 172.7 227.4 144 192.1 144L128.1 144C92.8 144 64.1 172.7 64.1 208L64.1 229.4C64.1 252.9 83.2 272 106.7 272C113.3 272 119.8 270.5 125.8 267.5C135.1 262.8 142.2 259.3 147 256.9L135.1 249C130.6 246 128 241 128 235.7L128 232C128 218.7 138.7 208 152 208L168 208C181.3 208 192 218.7 192 232L192 235.7C192 241 189.3 246 184.9 249L173.1 256.9L181.5 261.1zM172.9 310.5L160 304.1L147.1 310.5C134.5 316.8 120.6 320.1 106.6 320.1C103 320.1 99.5 319.9 96 319.5L96 320.1C96 355.4 124.7 384.1 160 384.1L224 384.1C241.7 384.1 256 398.4 256 416.1C256 433.8 241.7 448.1 224 448.1L384 448.1L384 384.1C384 360.4 396.9 339.7 416 328.7C425.4 323.3 436.3 320.1 448 320.1L448 304.1C448 277.6 469.5 256.1 496 256.1C504.8 256.1 512 263.3 512 272.1L512 368.1C512 376.9 519.2 384.1 528 384.1C536.8 384.1 544 376.9 544 368.1L544 268.4C544 220.2 513.2 177.4 467.4 162.1L458.9 159.3C450.9 156.6 446.3 148.2 448.5 140C450.7 131.8 458.8 126.8 467.1 128.4L487 132.4C576 150.1 640 228.2 640 318.9L640 320L640 320C640 443.7 539.7 544 416 544L255.4 544C132 544 32 444 32 320.6L32 280.8C21.9 266.2 16 248.5 16 229.4L16 208L16 206.6C6.7 203.3 0 194.5 0 184C0 170.7 10.7 160 24 160L26.8 160C44.8 122.2 83.3 96 128 96L192 96C236.7 96 275.2 122.2 293.2 160L296 160C309.3 160 320 170.7 320 184C320 194.5 313.3 203.3 304 206.6L304 208L304 229.4C304 230.8 304 232.2 303.9 233.7C315.9 227.5 329.6 224.1 344 224.1L352 224.1C369.7 224.1 384 238.4 384 256.1C384 273.8 369.7 288.1 352 288.1L344 288.1C330.7 288.1 320 298.8 320 312.1L320 320.1L376.4 320.1C361.2 337.1 352 359.5 352 384.1L320 384.1C277.7 384.1 241.8 356.7 229 318.8C223.9 319.7 218.7 320.1 213.4 320.1C199.3 320.1 185.5 316.8 172.9 310.5zM96 192C104.8 192 112 199.2 112 208C112 216.8 104.8 224 96 224C87.2 224 80 216.8 80 208C80 199.2 87.2 192 96 192zM208 208C208 199.2 215.2 192 224 192C232.8 192 240 199.2 240 208C240 216.8 232.8 224 224 224C215.2 224 208 216.8 208 208z"/></svg>
|
||||
|
After Width: | Height: | Size: 2.2 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Pro 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M460.7 39.3l-2.2-2.1c-4.7-4.6-11.5-6.4-17.9-4.7s-11.4 6.6-13.1 13l-.8 2.9c-3.3 11.8-5.1 23.7-5.5 35.6 24.3 20.6 42.9 47.8 53.3 78.8-8.2-1.9-16.5-2.9-25-2.9-.6 0-1.1 0-1.7 0-18.4-44-56.5-77.4-103.6-89.3l-3.4-.9c-6.2-1.6-12.9-.6-18.5 2.6-10.8 6.2-15.6 19.5-11.2 31.1 14.9 39.5 44.3 71.4 81.4 89.7-3.7 6.6-6.4 14-7.6 21.8L279.7 154.9c-30.9-17.7-65.9-26.9-101.5-26.9-32.3 0-62.2 16.8-78.9 44.4-10.3-12.5-25.8-20.4-43.2-20.4-30.9 0-56 25.1-56 56s25.1 56 56 56c11.3 0 21.8-3.3 30.6-9.1 4.9 17.2 14.5 33.1 28.4 45.9L257.2 431.2C269 442 284.4 448 300.4 448L416 448c17.7 0 32-14.3 32-32s-14.3-32-32-32l-96 0 0-43.5c0-42.9-28.4-80.5-69.6-92.3l-30.8-8.8c-8.5-2.4-13.4-11.3-11-19.8s11.3-13.4 19.8-11l30.8 8.8c55 15.7 92.8 65.9 92.8 123.1l0 15.7 56-32.4 6.4-3.7 101.3 0c33.3 0 60.3-27 60.3-60.3 0-18.1-8.2-35.3-22.2-46.7l-34.6-28.2c-4.6-3.7-9.4-7.1-14.5-10 8.4-49.3-7.8-100-43.9-135.5zm-318.5 382c-14.7 9.8-18.7 29.7-8.9 44.4s29.7 18.7 44.4 8.9l46-30.7-48.6-44.5-32.9 22zM480 240a16 16 0 1 1 32 0 16 16 0 1 1 -32 0z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Pro 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M384 249.2c0 21.4-17.4 38.8-38.8 38.8L70.8 288C49.4 288 32 270.6 32 249.2L32 208c0-97.2 78.8-176 176-176s176 78.8 176 176l0 41.2zM480 288c-2 0-4-.1-5.9-.3-16.3 53.3-64.3 92.7-122.1 96l0 56.2c0 22.1-17.9 40-40 40l-48 0c-22.1 0-40-17.9-40-40l0-56-32 0 0 56c0 22.1-17.9 40-40 40l-48 0c-22.1 0-40-17.9-40-40l0-56-32 0c-17.7 0-32-14.3-32-32s14.3-32 32-32l312 0c39.8 0 72-32.2 72-72l0-72c0-35.3 28.7-64 64-64 53 0 96 43 96 96l0 16c0 35.3-28.7 64-64 64l-32 0zm16-64a16 16 0 1 0 0-32 16 16 0 1 0 0 32z"/></svg>
|
||||
|
After Width: | Height: | Size: 761 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Pro 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M320 128c0-35.3 28.7-64 64-64s64 28.7 64 64l0 128 64 0 0-128C512 57.3 454.7 0 384 0S256 57.3 256 128l0 64-192 0c-35.3 0-64 28.7-64 64L0 448c0 35.3 28.7 64 64 64l256 0c35.3 0 64-28.7 64-64l0-192c0-35.3-28.7-64-64-64l0-64zM64 256l256 0 0 192-256 0 0-192z"/></svg>
|
||||
|
After Width: | Height: | Size: 520 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--! Font Awesome Pro 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M205 64L434.9 64L439.3 82.4L475.6 234.9C478.5 247 480 259.5 480 272C480 352.2 421 418.7 344 430.2L344 560L432 560L432 608L208 608L208 560L296 560L296 430.2C219 418.6 160 352.2 160 272C160 259.5 161.5 247 164.4 234.9L200.7 82.4L205 64zM243 112L211 246C209 254.5 208 263.2 208 272C208 333.9 258.2 384 320 384C381.8 384 432 333.8 432 272C432 263.3 431 254.5 429 246L397.1 112L371.3 112L384.1 176L320.1 216L352.1 320L256.1 216L328.1 144L306.8 112L243.1 112z"/></svg>
|
||||
|
After Width: | Height: | Size: 721 B |
@@ -0,0 +1,335 @@
|
||||
//! Real access / lock-state detection: whether this miner accepts privileged
|
||||
//! (credentialed) command writes, or is view-only.
|
||||
//!
|
||||
//! asic-rs has no lock-state signal (a wrong-password miner just silently
|
||||
//! returns fewer fields, because the collector drops the 401). We build the real
|
||||
//! check ON TOP of asic-rs: a NON-mutating, digest-authenticated GET to a
|
||||
//! privileged endpoint. On Antminer every `/cgi-bin/*.cgi` requires digest auth,
|
||||
//! so the HTTP status is decisive -- 200 means our credentials authenticate
|
||||
//! (we can write -> unlocked), 401/403 means they are rejected (view-only ->
|
||||
//! locked). We probe `get_miner_conf.cgi`, which is read-only (never the
|
||||
//! mutating `set_miner_conf.cgi`).
|
||||
//!
|
||||
//! We shell out to `curl --digest` (already present, supports digest auth)
|
||||
//! rather than add an HTTP+digest crate, so the offline/vendored build is
|
||||
//! unaffected. `Some(true)` = locked, `Some(false)` = unlocked, `None` =
|
||||
//! indeterminate (unreachable, or an endpoint/vendor this probe doesn't cover).
|
||||
//!
|
||||
//! WhatsMiner has no such digest-gated web endpoint (it returns a 307 redirect
|
||||
//! for the Antminer paths, so the curl probe always read "indeterminate" and the
|
||||
//! table fell back to a capability guess that marked older units "locked" even
|
||||
//! with the default login -- round 12 #8b). Instead we run the WhatsMiner
|
||||
//! :4028 token handshake: `get_token` (unauthenticated) yields a salt, we derive
|
||||
//! the AES key from the password, and send a NON-mutating encrypted `summary`.
|
||||
//! An encrypted reply means the key (hence password) was accepted -> unlocked;
|
||||
//! a plaintext `enc json load err` means it was rejected -> locked.
|
||||
|
||||
use std::io::{Read, Write};
|
||||
use std::net::{SocketAddr, TcpStream};
|
||||
use std::process::Command;
|
||||
use std::time::Duration;
|
||||
|
||||
use aes::Aes256;
|
||||
use aes::cipher::{BlockEncryptMut, KeyInit, block_padding::ZeroPadding};
|
||||
use base64::Engine;
|
||||
use base64::engine::general_purpose::STANDARD as BASE64;
|
||||
use sha2::{Digest, Sha256};
|
||||
|
||||
type Aes256EcbEnc = ecb::Encryptor<Aes256>;
|
||||
|
||||
/// Classify a miner's access state from an HTTP status code string (curl's
|
||||
/// `%{http_code}` output). Conservative: anything other than a clear
|
||||
/// authenticated/unauthorized answer is `None`.
|
||||
pub fn classify_http_code(code: &str) -> Option<bool> {
|
||||
match code.trim() {
|
||||
"200" | "204" => Some(false), // authenticated -> unlocked/writable
|
||||
"401" | "403" => Some(true), // rejected -> locked/view-only
|
||||
_ => None, // 000 (no connect), 404, 5xx, ... -> unknown
|
||||
}
|
||||
}
|
||||
|
||||
/// The privileged, read-only endpoint we probe per firmware family. Antminer
|
||||
/// stock/aftermarket all gate `get_miner_conf.cgi` behind digest auth.
|
||||
fn endpoint(_firmware: &str) -> &'static str {
|
||||
"/cgi-bin/get_miner_conf.cgi"
|
||||
}
|
||||
|
||||
/// Probe one miner's access state. `make` is the miner brand ("Whatsminer" /
|
||||
/// "Antminer"): WhatsMiner uses the :4028 token handshake, everything else the
|
||||
/// digest-auth web probe. Returns `Ok(Some(true/false))` on a decisive
|
||||
/// lock/unlock answer, `Ok(None)` if indeterminate, `Err` only on a probe that
|
||||
/// could not run at all.
|
||||
pub fn probe_access(ip: &str, make: &str, user: &str, pass: &str) -> Result<Option<bool>, String> {
|
||||
if make.eq_ignore_ascii_case("whatsminer") {
|
||||
// Try the caller's saved scan password first (round 18 #12: it was being
|
||||
// ignored for WhatsMiner, so a miner opened with the operator's real
|
||||
// password was mis-reported as locked), then the per-firmware override and
|
||||
// factory defaults. All attempts are non-mutating.
|
||||
let mut candidates = Vec::new();
|
||||
if !pass.is_empty() {
|
||||
candidates.push(pass.to_string());
|
||||
}
|
||||
for c in whatsminer_password_candidates() {
|
||||
if !candidates.contains(&c) {
|
||||
candidates.push(c);
|
||||
}
|
||||
}
|
||||
return Ok(probe_whatsminer_access(ip, &candidates));
|
||||
}
|
||||
let url = format!("http://{ip}{}", endpoint(make));
|
||||
let mut cmd = Command::new("curl");
|
||||
cmd.args([
|
||||
"-s",
|
||||
"-o",
|
||||
"/dev/null",
|
||||
"-w",
|
||||
"%{http_code}",
|
||||
"--digest",
|
||||
"--connect-timeout",
|
||||
"5",
|
||||
"--max-time",
|
||||
"9",
|
||||
"-K",
|
||||
"-", // read the rest of the config (the credentials) from stdin
|
||||
&url,
|
||||
]);
|
||||
// The user:pass goes through a curl config on stdin, never argv, so it can't
|
||||
// be read from the process list (round 18 #12).
|
||||
let config = format!("user = \"{}\"\n", curl_config_quote(&format!("{user}:{pass}")));
|
||||
let out = wait_with_timeout(cmd, Duration::from_secs(12), Some(config.as_bytes()))?;
|
||||
// curl prints the status code to stdout regardless of exit status (000 on a
|
||||
// connection failure), so classify the code rather than the exit status.
|
||||
let code = String::from_utf8_lossy(&out.stdout);
|
||||
Ok(classify_http_code(&code))
|
||||
}
|
||||
|
||||
/// Run a command with a wall-clock timeout (curl can hang past --max-time on a
|
||||
/// black-holed host). `stdin_data`, when set, is written to the child's stdin and
|
||||
/// the pipe closed -- used to feed a curl config (with the credentials) instead
|
||||
/// of putting them on the command line (round 18 #12).
|
||||
fn wait_with_timeout(
|
||||
mut cmd: Command,
|
||||
timeout: Duration,
|
||||
stdin_data: Option<&[u8]>,
|
||||
) -> Result<std::process::Output, String> {
|
||||
use std::io::{Read, Write};
|
||||
cmd.stdout(std::process::Stdio::piped()).stderr(std::process::Stdio::piped());
|
||||
if stdin_data.is_some() {
|
||||
cmd.stdin(std::process::Stdio::piped());
|
||||
}
|
||||
let mut child = cmd.spawn().map_err(|e| format!("spawn curl: {e}"))?;
|
||||
if let Some(data) = stdin_data {
|
||||
if let Some(mut si) = child.stdin.take() {
|
||||
let _ = si.write_all(data);
|
||||
} // dropping `si` closes the pipe so curl stops reading the config
|
||||
}
|
||||
let start = std::time::Instant::now();
|
||||
loop {
|
||||
match child.try_wait().map_err(|e| e.to_string())? {
|
||||
Some(status) => {
|
||||
let mut stdout = Vec::new();
|
||||
let mut stderr = Vec::new();
|
||||
if let Some(mut o) = child.stdout.take() {
|
||||
let _ = o.read_to_end(&mut stdout);
|
||||
}
|
||||
if let Some(mut e) = child.stderr.take() {
|
||||
let _ = e.read_to_end(&mut stderr);
|
||||
}
|
||||
return Ok(std::process::Output { status, stdout, stderr });
|
||||
}
|
||||
None => {
|
||||
if start.elapsed() >= timeout {
|
||||
let _ = child.kill();
|
||||
let _ = child.wait(); // reap so we never leave a zombie (round 18 #12)
|
||||
return Err("curl timed out".into());
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(100));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Escape a value for a curl `--config` file (double-quoted string).
|
||||
fn curl_config_quote(s: &str) -> String {
|
||||
s.replace('\\', "\\\\").replace('"', "\\\"")
|
||||
}
|
||||
|
||||
/// Passwords to try for a WhatsMiner access check: a user-set per-firmware
|
||||
/// override (round 12 #13) wins; otherwise the two factory defaults ("admin" for
|
||||
/// V1/V2, "super" for V3). All attempts are non-mutating, so trying both is safe.
|
||||
fn whatsminer_password_candidates() -> Vec<String> {
|
||||
if let Some((_, pass)) = crate::credentials::load_firmware_credentials().get("WhatsMiner Stock") {
|
||||
if !pass.is_empty() {
|
||||
return vec![pass.clone()];
|
||||
}
|
||||
}
|
||||
vec!["admin".to_string(), "super".to_string()]
|
||||
}
|
||||
|
||||
/// Fetch a WhatsMiner's active fault codes over the unauthenticated :4028
|
||||
/// get_error_code command and format them one per line for the log viewer
|
||||
/// (round 12 #12). Returns None if the miner does not answer.
|
||||
pub fn whatsminer_get_error_code(ip: &str) -> Option<String> {
|
||||
let resp = wm_rpc(ip, "{\"command\":\"get_error_code\"}", Duration::from_secs(6)).ok()?;
|
||||
let v: serde_json::Value = serde_json::from_str(&resp).ok()?;
|
||||
let codes = v.get("Msg").and_then(|m| m.get("error_code")).and_then(|c| c.as_array());
|
||||
let mut lines = vec![format!("WhatsMiner get_error_code ({ip}):")];
|
||||
match codes {
|
||||
Some(arr) if !arr.is_empty() => {
|
||||
for entry in arr {
|
||||
if let Some(obj) = entry.as_object() {
|
||||
for (code, when) in obj {
|
||||
lines.push(format!(" error {code}: {}", when.as_str().unwrap_or("")));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
_ => lines.push(" no active error codes".to_string()),
|
||||
}
|
||||
Some(lines.join("\n"))
|
||||
}
|
||||
|
||||
/// One WhatsMiner :4028 request/response (the miner closes the socket after it
|
||||
/// replies). Returns the NUL-trimmed body.
|
||||
fn wm_rpc(ip: &str, payload: &str, timeout: Duration) -> Result<String, String> {
|
||||
let addr: SocketAddr = format!("{ip}:4028")
|
||||
.parse()
|
||||
.map_err(|e| format!("bad address {ip}: {e}"))?;
|
||||
let mut stream = TcpStream::connect_timeout(&addr, timeout).map_err(|e| e.to_string())?;
|
||||
stream.set_read_timeout(Some(timeout)).ok();
|
||||
stream.set_write_timeout(Some(timeout)).ok();
|
||||
stream.write_all(payload.as_bytes()).map_err(|e| e.to_string())?;
|
||||
let mut buf = Vec::new();
|
||||
let mut chunk = [0u8; 4096];
|
||||
loop {
|
||||
match stream.read(&mut chunk) {
|
||||
Ok(0) => break,
|
||||
Ok(n) => {
|
||||
buf.extend_from_slice(&chunk[..n]);
|
||||
if buf.len() > 1 << 20 {
|
||||
break; // cap a runaway response
|
||||
}
|
||||
}
|
||||
Err(_) => break,
|
||||
}
|
||||
}
|
||||
Ok(String::from_utf8_lossy(&buf).trim_matches('\u{0}').to_string())
|
||||
}
|
||||
|
||||
/// AES-256-ECB encrypt `data` under SHA256(pwd_md5), base64-encoded -- the exact
|
||||
/// scheme the WhatsMiner btminer API expects (mirrors the vendored asic-rs
|
||||
/// whatsminer v2 backend).
|
||||
fn wm_aes_ecb_enc(pwd_md5: &str, data: &str) -> Option<String> {
|
||||
let key = Sha256::digest(pwd_md5.as_bytes()); // 32 bytes
|
||||
let mut buffer = data.as_bytes().to_vec();
|
||||
while !buffer.len().is_multiple_of(16) {
|
||||
buffer.push(0);
|
||||
}
|
||||
let ct = Aes256EcbEnc::new_from_slice(&key)
|
||||
.ok()?
|
||||
.encrypt_padded_mut::<ZeroPadding>(&mut buffer, data.len())
|
||||
.ok()?;
|
||||
Some(BASE64.encode(ct))
|
||||
}
|
||||
|
||||
/// Check a WhatsMiner's access via the :4028 token handshake, trying each
|
||||
/// candidate password. Returns `Some(false)` (unlocked) on the first password
|
||||
/// the miner accepts, `Some(true)` (locked) if all are rejected, `None` if the
|
||||
/// miner is unreachable or speaks an unexpected dialect. Non-mutating: only
|
||||
/// `get_token` and a read-only `summary` are ever sent.
|
||||
fn probe_whatsminer_access(ip: &str, passwords: &[String]) -> Option<bool> {
|
||||
let timeout = Duration::from_secs(6);
|
||||
let mut reachable = false;
|
||||
// A transient error on one candidate must not abandon the others (round 18 #12):
|
||||
// skip to the next candidate, but remember it happened so we never report a
|
||||
// confident "locked" when the answer was really indeterminate.
|
||||
let mut errored = false;
|
||||
for pass in passwords {
|
||||
// 1. get_token (no auth) -> salt / newsalt / time.
|
||||
let tok_resp = match wm_rpc(ip, "{\"command\":\"get_token\"}", timeout) {
|
||||
Ok(s) => s,
|
||||
Err(_) => {
|
||||
errored = true;
|
||||
continue;
|
||||
}
|
||||
};
|
||||
let v: serde_json::Value = match serde_json::from_str(&tok_resp) {
|
||||
Ok(v) => v,
|
||||
Err(_) => {
|
||||
errored = true;
|
||||
continue;
|
||||
}
|
||||
};
|
||||
let (Some(salt), Some(newsalt), Some(time)) = v
|
||||
.get("Msg")
|
||||
.map(|msg| {
|
||||
(
|
||||
msg.get("salt").and_then(|s| s.as_str()),
|
||||
msg.get("newsalt").and_then(|s| s.as_str()),
|
||||
msg.get("time").and_then(|s| s.as_str()),
|
||||
)
|
||||
})
|
||||
.unwrap_or((None, None, None))
|
||||
else {
|
||||
errored = true;
|
||||
continue;
|
||||
};
|
||||
reachable = true;
|
||||
// 2. Derive the md5crypt password hash + write-token from the password.
|
||||
let crypted = md5crypt::md5crypt(pass.as_bytes(), salt.as_bytes());
|
||||
let full = String::from_utf8_lossy(&crypted);
|
||||
let Some(pwd_md5) = full.split('$').nth(3) else { continue };
|
||||
let sign_crypted = md5crypt::md5crypt(format!("{pwd_md5}{time}").as_bytes(), newsalt.as_bytes());
|
||||
let sign_full = String::from_utf8_lossy(&sign_crypted);
|
||||
let host_sign = sign_full.split('$').nth(3).unwrap_or("");
|
||||
// 3. Send an encrypted, read-only `summary`. If the AES key (from the
|
||||
// password) is right the miner replies encrypted; if wrong it returns
|
||||
// a plaintext "enc json load err".
|
||||
let cmd = format!("{{\"command\":\"summary\",\"token\":\"{host_sign}\"}}");
|
||||
let Some(enc) = wm_aes_ecb_enc(pwd_md5, &cmd) else { continue };
|
||||
let payload = format!("{{\"enc\":1,\"data\":\"{enc}\"}}");
|
||||
let resp = match wm_rpc(ip, &payload, timeout) {
|
||||
Ok(s) => s,
|
||||
Err(_) => {
|
||||
errored = true;
|
||||
continue;
|
||||
}
|
||||
};
|
||||
if resp.contains("\"enc\"") {
|
||||
return Some(false); // accepted -> unlocked/writable
|
||||
}
|
||||
// rejected -> try the next candidate password
|
||||
}
|
||||
// Only report "locked" when we cleanly reached the miner and every candidate
|
||||
// was rejected with no transient errors; otherwise the result is indeterminate.
|
||||
if reachable && !errored { Some(true) } else { None }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn classify_codes() {
|
||||
assert_eq!(classify_http_code("200"), Some(false), "authenticated -> unlocked");
|
||||
assert_eq!(classify_http_code("204"), Some(false));
|
||||
assert_eq!(classify_http_code("401"), Some(true), "unauthorized -> locked");
|
||||
assert_eq!(classify_http_code("403"), Some(true));
|
||||
assert_eq!(classify_http_code("000"), None, "no connection -> unknown");
|
||||
assert_eq!(classify_http_code("404"), None, "endpoint absent -> unknown");
|
||||
assert_eq!(classify_http_code("500"), None);
|
||||
assert_eq!(classify_http_code(" 200 "), Some(false), "whitespace tolerated");
|
||||
assert_eq!(classify_http_code(""), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn whatsminer_aes_ecb_matches_reference() {
|
||||
// Deterministic vector from the verified btminer scheme: AES-256-ECB over
|
||||
// SHA256(pwd_md5), zero-padded, base64. Guards the WhatsMiner access
|
||||
// handshake crypto (round 12 #8b) without needing a live miner.
|
||||
assert_eq!(
|
||||
wm_aes_ecb_enc("abc123def456", "{\"command\":\"summary\"}").as_deref(),
|
||||
Some("jn5Wru/5hhMtU1IgamxLoUd/YTxaLTxEeiCQxu5pO+Q=")
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,758 @@
|
||||
//! miner_probe -- a read-only (by default) asic-rs diagnostic for live-hardware
|
||||
//! verification of the round-9 power-limit work. It reuses the same MinerFactory
|
||||
//! and saved-credential setup the GUI uses (see crate::credentials), but as a
|
||||
//! standalone CLI so hardware checks don't go through the wx event loop.
|
||||
//!
|
||||
//! Usage:
|
||||
//! miner_probe scan <cidr> [<cidr>...]
|
||||
//! Scan the given subnets and print, per responder (TSV):
|
||||
//! ip make firmware model_id control_board watts supports_power_limit supports_tuning
|
||||
//!
|
||||
//! miner_probe setpl <ip> <watts>
|
||||
//! Apply a power limit to ONE miner and print the setter's result. This
|
||||
//! MUTATES the device -- capture and restore its prior configured limit
|
||||
//! separately (e.g. WhatsMiner cgminer API on :4028 reports "Power Limit"
|
||||
//! read-only). asic-rs has no power-limit read-back, so this tool cannot
|
||||
//! restore on its own.
|
||||
//!
|
||||
//! Credentials come from ~/.config/alkane-toolkit/scan-credentials.txt, or from
|
||||
//! ALKANE_PROBE_USER / ALKANE_PROBE_PASS if set (so a test can authenticate
|
||||
//! without touching the app's saved config).
|
||||
|
||||
use asic_rs::MinerFactory;
|
||||
use asic_rs::core::traits::miner::MinerAuth;
|
||||
use futures_util::StreamExt;
|
||||
use measurements::Power;
|
||||
|
||||
fn load_creds() -> Option<(String, String)> {
|
||||
if let (Ok(u), Ok(pw)) = (std::env::var("ALKANE_PROBE_USER"), std::env::var("ALKANE_PROBE_PASS")) {
|
||||
return Some((u, pw));
|
||||
}
|
||||
let home = std::env::var("HOME").ok()?;
|
||||
let p = std::path::PathBuf::from(home)
|
||||
.join(".config/alkane-toolkit/scan-credentials.txt");
|
||||
let s = std::fs::read_to_string(p).ok()?;
|
||||
let mut l = s.lines();
|
||||
let u = l.next()?.to_string();
|
||||
let pw = l.next().unwrap_or("").to_string();
|
||||
Some((u, pw))
|
||||
}
|
||||
|
||||
fn factory() -> MinerFactory {
|
||||
// This diagnostic CLI is a separate binary from the GUI, so it cannot share
|
||||
// the GUI's credentials::configured_factory. It applies only the global scan
|
||||
// credentials to every firmware; the GUI's per-firmware credential overrides
|
||||
// are NOT read here (round 18 #12), which the message below makes explicit so a
|
||||
// probe result is never mistaken for what the GUI (with overrides) would see.
|
||||
let mut f = MinerFactory::new();
|
||||
if let Some((u, pw)) = load_creds() {
|
||||
for fw in asic_rs::factory::default_firmware_registry() {
|
||||
f = f.with_firmware_discovery_auth(fw.as_ref(), MinerAuth::new(u.clone(), pw.clone()));
|
||||
}
|
||||
eprintln!("(using the global scan credentials; per-firmware overrides are not applied)");
|
||||
} else {
|
||||
eprintln!("(no saved credentials -- backends use their default auth)");
|
||||
}
|
||||
f
|
||||
}
|
||||
|
||||
async fn scan(cidrs: &[String]) {
|
||||
let mut f = factory();
|
||||
for c in cidrs {
|
||||
f = match f.with_subnet(c) {
|
||||
Ok(f) => f,
|
||||
Err(e) => {
|
||||
eprintln!("bad subnet {c}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
}
|
||||
// Cap identification concurrency to match the GUI (see
|
||||
// scan::SCAN_CONCURRENCY_LIMIT). asic-rs defaults to 1000, which over a real
|
||||
// link starves the per-responder get_data -- Braiins miners drop most values
|
||||
// (watts=0, no best-share) and some responders are missed entirely. 128 is the
|
||||
// highest cap that stayed fully reliable on the live fleet. ALKANE_PROBE_CONCURRENCY
|
||||
// overrides it for diagnostics.
|
||||
let concurrency = std::env::var("ALKANE_PROBE_CONCURRENCY")
|
||||
.ok()
|
||||
.and_then(|c| c.parse::<usize>().ok())
|
||||
.unwrap_or(128);
|
||||
eprintln!("(scan concurrency = {concurrency})");
|
||||
f = f.with_concurrent_limit(concurrency);
|
||||
println!("ip\tmake\tfirmware\tfw_version\tmodel_id\tcontrol_board\twatts\tsupports_power_limit\tsupports_tuning\tbest_share\tsession_best_share");
|
||||
let mut stream = f.scan_stream_with_ip();
|
||||
let mut found = 0usize;
|
||||
while let Some((ip, miner)) = stream.next().await {
|
||||
if let Some(m) = miner {
|
||||
let data = m.get_data().await;
|
||||
let watts = data.wattage.as_ref().map(|p| p.as_watts()).unwrap_or(0.0);
|
||||
let cb = data
|
||||
.control_board_version
|
||||
.as_ref()
|
||||
.map(|c| c.to_string())
|
||||
.unwrap_or_default();
|
||||
let fw_ver = data.firmware_version.clone().unwrap_or_default();
|
||||
let bs = data.best_share.map(|v| format!("{v:.0}")).unwrap_or_default();
|
||||
let sbs = data.session_best_share.map(|v| format!("{v:.0}")).unwrap_or_default();
|
||||
println!(
|
||||
"{ip}\t{}\t{}\t{}\t{}\t{}\t{watts:.0}\t{}\t{}\t{bs}\t{sbs}",
|
||||
data.device_info.make,
|
||||
data.device_info.firmware,
|
||||
fw_ver,
|
||||
data.device_info.model,
|
||||
cb,
|
||||
m.supports_set_power_limit(),
|
||||
m.supports_set_tuning_percent(),
|
||||
);
|
||||
found += 1;
|
||||
}
|
||||
}
|
||||
eprintln!("scan complete: {found} miner(s) responded");
|
||||
}
|
||||
|
||||
/// Dump raw hashrate value/unit/algo (and expected) as asic-rs reports them,
|
||||
/// to diagnose the SI-prefix handling for non-SHA algorithms (round-9 #8, Z15).
|
||||
async fn hashrate(cidrs: &[String]) {
|
||||
let mut f = factory();
|
||||
for c in cidrs {
|
||||
f = match f.with_subnet(c) {
|
||||
Ok(f) => f,
|
||||
Err(e) => {
|
||||
eprintln!("bad subnet {c}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
}
|
||||
println!("ip\tmodel\talgo\thr_value\thr_unit\texp_value\texp_unit");
|
||||
let mut stream = f.scan_stream_with_ip();
|
||||
while let Some((ip, miner)) = stream.next().await {
|
||||
if let Some(m) = miner {
|
||||
let data = m.get_data().await;
|
||||
let hr = data.hashrate.as_ref();
|
||||
let exp = data.expected_hashrate.as_ref();
|
||||
println!(
|
||||
"{ip}\t{}\t{}\t{}\t{}\t{}\t{}",
|
||||
data.device_info.model,
|
||||
hr.map(|h| h.algo.to_string()).unwrap_or_default(),
|
||||
hr.map(|h| h.value).unwrap_or(0.0),
|
||||
hr.map(|h| format!("{:?}", h.unit)).unwrap_or_default(),
|
||||
exp.map(|h| h.value).unwrap_or(0.0),
|
||||
exp.map(|h| format!("{:?}", h.unit)).unwrap_or_default(),
|
||||
);
|
||||
}
|
||||
}
|
||||
eprintln!("hashrate dump complete");
|
||||
}
|
||||
|
||||
async fn setpl(ip_s: &str, watts: f64) {
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let data = m.get_data().await;
|
||||
eprintln!(
|
||||
"target {ip}: {} {} {} (supports_power_limit={})",
|
||||
data.device_info.make,
|
||||
data.device_info.firmware,
|
||||
data.device_info.model,
|
||||
m.supports_set_power_limit()
|
||||
);
|
||||
match m.set_power_limit(Power::from_watts(watts)).await {
|
||||
Ok(v) => println!("set_power_limit({watts:.0} W) -> Ok({v})"),
|
||||
// {e:#} prints the full anyhow chain (the miner's own Msg is the
|
||||
// root cause), which is exactly what we need to characterise #4.
|
||||
Err(e) => println!("set_power_limit({watts:.0} W) -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// LOCAL-ONLY: toggle a miner's locate light on then back off, to validate the
|
||||
/// (token-authenticated) write path safely -- the LED is reversible and does not
|
||||
/// disturb mining. Restores the light to off afterward.
|
||||
async fn led(ip_s: &str) {
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let data = m.get_data().await;
|
||||
eprintln!(
|
||||
"target {ip}: {} {} {} (supports_set_fault_light={})",
|
||||
data.device_info.make,
|
||||
data.device_info.firmware,
|
||||
data.device_info.model,
|
||||
m.supports_set_fault_light()
|
||||
);
|
||||
match m.set_fault_light(true).await {
|
||||
Ok(v) => println!("set_fault_light(on) -> Ok({v})"),
|
||||
Err(e) => println!("set_fault_light(on) -> Err: {e:#}"),
|
||||
}
|
||||
let after_on = m.get_data().await.light_flashing;
|
||||
println!(" light_flashing after on = {after_on:?}");
|
||||
// Restore: turn the locate light back off.
|
||||
match m.set_fault_light(false).await {
|
||||
Ok(v) => println!("set_fault_light(off) [restore] -> Ok({v})"),
|
||||
Err(e) => println!("set_fault_light(off) [restore] -> Err: {e:#}"),
|
||||
}
|
||||
let after_off = m.get_data().await.light_flashing;
|
||||
println!(" light_flashing after off = {after_off:?}");
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Apply a single "default" pool group to ONE miner via asic-rs set_pools_config
|
||||
/// (the same path the GUI's pool feature uses). MUTATES the device's pool config.
|
||||
/// Usage: setpools <ip> <url> <user> <pass>
|
||||
async fn setpools(ip_s: &str, url: &str, user: &str, pass: &str) {
|
||||
use asic_rs::core::config::pools::{PoolConfig, PoolGroupConfig};
|
||||
use asic_rs::core::data::pool::PoolURL;
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let data = m.get_data().await;
|
||||
eprintln!(
|
||||
"target {ip}: {} {} {} (supports_pools_config={})",
|
||||
data.device_info.make,
|
||||
data.device_info.firmware,
|
||||
data.device_info.model,
|
||||
m.supports_pools_config()
|
||||
);
|
||||
let group = PoolGroupConfig {
|
||||
name: "default".to_string(),
|
||||
quota: 1,
|
||||
pools: vec![PoolConfig {
|
||||
url: PoolURL::from(url.to_string()),
|
||||
username: user.to_string(),
|
||||
password: pass.to_string(),
|
||||
}],
|
||||
};
|
||||
match m.set_pools_config(vec![group]).await {
|
||||
Ok(v) => println!("set_pools_config -> Ok({v})"),
|
||||
Err(e) => println!("set_pools_config -> Err: {e:#}"),
|
||||
}
|
||||
// Read back the configured pools to verify.
|
||||
let after = m.get_data().await;
|
||||
for (i, p) in after.pools.iter().flat_map(|g| g.pools.iter()).enumerate() {
|
||||
let u = p.url.as_ref().map(|u| u.to_string()).unwrap_or_default();
|
||||
let acct = p.user.clone().unwrap_or_default();
|
||||
println!(" pool[{i}] {u} user={acct}");
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// READ-ONLY: dump a miner's structured messages (code + severity + component +
|
||||
/// text) plus its per-board data, to design health/error attribution.
|
||||
async fn msgs(ip_s: &str) {
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let d = m.get_data().await;
|
||||
let th = |h: &Option<asic_rs::core::data::hashrate::HashRate>| {
|
||||
h.clone().map(|x| x.as_unit(asic_rs::core::data::hashrate::HashRateUnit::TeraHash).value)
|
||||
};
|
||||
println!(
|
||||
"{ip}: {} {} hashboards={:?} expected={:?}",
|
||||
d.device_info.firmware,
|
||||
d.device_info.model,
|
||||
d.hashboards.len(),
|
||||
d.expected_hashboards,
|
||||
);
|
||||
println!(
|
||||
" TOTAL hashrate={:?} TH wattage={:?} W fluid/env_temp={:?} best_share={:?}",
|
||||
th(&d.hashrate),
|
||||
d.wattage.as_ref().map(|p| p.as_watts()),
|
||||
d.fluid_temperature.as_ref().map(|t| t.as_celsius()),
|
||||
d.best_share,
|
||||
);
|
||||
let fans: Vec<i64> = d
|
||||
.fans
|
||||
.iter()
|
||||
.map(|f| f.rpm.as_ref().map(|r| r.as_rpm() as i64).unwrap_or(-1))
|
||||
.collect();
|
||||
println!(" fans(rpm)={fans:?} psu_fans={}", d.psu_fans.len());
|
||||
for b in d.hashboards.iter() {
|
||||
println!(
|
||||
" board pos={} hr={:?}TH chips={:?}/{:?} board_temp={:?} outlet_temp={:?} freq={:?}MHz volt={:?}V chip_type={:?} hb_model={:?}",
|
||||
b.position,
|
||||
th(&b.hashrate),
|
||||
b.working_chips,
|
||||
b.expected_chips,
|
||||
b.board_temperature.as_ref().map(|t| t.as_celsius()),
|
||||
b.outlet_chip_temperature.as_ref().map(|t| t.as_celsius()),
|
||||
b.frequency.as_ref().map(|f| f.as_megahertz()),
|
||||
b.voltage.as_ref().map(|v| v.as_volts()),
|
||||
b.chip_type,
|
||||
b.hashboard_model,
|
||||
);
|
||||
}
|
||||
if d.messages.is_empty() {
|
||||
println!(" (no messages)");
|
||||
}
|
||||
for msg in &d.messages {
|
||||
println!(
|
||||
" MSG code={} sev={:?} comp={:?} :: {}",
|
||||
msg.code, msg.severity, msg.component, msg.message
|
||||
);
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Set the locate light to an explicit on/off state (round 16/G1). Capability-gated.
|
||||
async fn light(ip_s: &str, on: bool) {
|
||||
let Ok(ip) = ip_s.parse::<std::net::IpAddr>() else {
|
||||
eprintln!("bad ip {ip_s}");
|
||||
return;
|
||||
};
|
||||
match factory().scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
if !m.supports_set_fault_light() {
|
||||
eprintln!("{ip}: locate light not supported");
|
||||
return;
|
||||
}
|
||||
match m.set_fault_light(on).await {
|
||||
Ok(v) => println!("{ip} light {} -> Ok({v})", if on { "on" } else { "off" }),
|
||||
Err(e) => println!("{ip} light -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Run a simple lifecycle action (restart / pause / resume) on one miner (G1).
|
||||
/// Capability-gated; MUTATES (pause/restart disrupt mining -- run on the test bed).
|
||||
async fn lifecycle(ip_s: &str, verb: &str) {
|
||||
let Ok(ip) = ip_s.parse::<std::net::IpAddr>() else {
|
||||
eprintln!("bad ip {ip_s}");
|
||||
return;
|
||||
};
|
||||
match factory().scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let res = match verb {
|
||||
"restart" if m.supports_restart() => m.restart().await,
|
||||
"pause" if m.supports_pause() => m.pause(None).await,
|
||||
"resume" if m.supports_resume() => m.resume(None).await,
|
||||
"restart" | "pause" | "resume" => {
|
||||
eprintln!("{ip}: {verb} not supported");
|
||||
return;
|
||||
}
|
||||
_ => {
|
||||
eprintln!("unknown lifecycle verb {verb}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
match res {
|
||||
Ok(v) => println!("{ip} {verb} -> Ok({v})"),
|
||||
Err(e) => println!("{ip} {verb} -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Read (no tz arg) or set the miner's timezone (round 16 / G10). Capability-gated.
|
||||
async fn timezone(ip_s: &str, tz: Option<&str>) {
|
||||
use asic_rs::core::config::timezone::{Tz, TimezoneConfig};
|
||||
let Ok(ip) = ip_s.parse::<std::net::IpAddr>() else {
|
||||
eprintln!("bad ip {ip_s}");
|
||||
return;
|
||||
};
|
||||
match factory().scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
if !m.supports_timezone_config() {
|
||||
eprintln!("{ip}: timezone config not supported");
|
||||
return;
|
||||
}
|
||||
if let Some(tz_s) = tz {
|
||||
let Ok(zone) = tz_s.parse::<Tz>() else {
|
||||
eprintln!("bad IANA timezone '{tz_s}' (e.g. America/Edmonton)");
|
||||
return;
|
||||
};
|
||||
let cfg = TimezoneConfig {
|
||||
timezone: Some(zone),
|
||||
available: Vec::new(),
|
||||
};
|
||||
match m.set_timezone_config(cfg).await {
|
||||
Ok(v) => println!("{ip} set timezone {zone} -> Ok({v})"),
|
||||
Err(e) => println!("{ip} set timezone -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
match m.get_timezone_config().await {
|
||||
Ok(c) => println!(
|
||||
"{ip} timezone now: {:?} ({} available)",
|
||||
c.timezone.map(|t| t.to_string()),
|
||||
c.available.len()
|
||||
),
|
||||
Err(e) => println!("{ip} read timezone -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Change the miner's web/API password (round 16 / G11). Capability-gated.
|
||||
/// DANGEROUS: a failed change can lock the toolkit out -- use a dedicated unit.
|
||||
async fn passwd(ip_s: &str, newpass: &str) {
|
||||
let Ok(ip) = ip_s.parse::<std::net::IpAddr>() else {
|
||||
eprintln!("bad ip {ip_s}");
|
||||
return;
|
||||
};
|
||||
match factory().scan_miner(ip).await {
|
||||
Ok(Some(mut m)) => {
|
||||
if !m.supports_change_password() {
|
||||
eprintln!("{ip}: change password not supported");
|
||||
return;
|
||||
}
|
||||
match m.change_password(newpass).await {
|
||||
Ok(v) => println!("{ip} change_password -> Ok({v})"),
|
||||
Err(e) => println!("{ip} change_password -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Factory-reset the miner (round 16 / G12). Capability-gated. DESTRUCTIVE:
|
||||
/// wipes config and may reset the network (unit can drop off its IP) -- only run
|
||||
/// on a sacrificial/console-attached unit.
|
||||
async fn factoryreset(ip_s: &str) {
|
||||
let Ok(ip) = ip_s.parse::<std::net::IpAddr>() else {
|
||||
eprintln!("bad ip {ip_s}");
|
||||
return;
|
||||
};
|
||||
match factory().scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
if !m.supports_factory_reset() {
|
||||
eprintln!("{ip}: factory reset not supported");
|
||||
return;
|
||||
}
|
||||
match m.factory_reset().await {
|
||||
Ok(v) => println!("{ip} factory_reset -> Ok({v})"),
|
||||
Err(e) => println!("{ip} factory_reset -> Err: {e:#}"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// READ-ONLY: dump a miner's structured-tuning surface -- what it supports, its
|
||||
/// current target, and the capability envelope (power/hashrate min-max, or the
|
||||
/// preset/mode list) the firmware advertises. Drives the round-17 C tuning work:
|
||||
/// it shows what each live firmware actually offers before any write is wired up.
|
||||
async fn tune(ip_s: &str) {
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let data = m.get_data().await;
|
||||
println!(
|
||||
"{ip}: {} {} {}",
|
||||
data.device_info.make, data.device_info.firmware, data.device_info.model
|
||||
);
|
||||
println!(
|
||||
" supports: power_limit={} tuning_percent={} tuning_config={}",
|
||||
m.supports_set_power_limit(),
|
||||
m.supports_set_tuning_percent(),
|
||||
m.supports_tuning_config(),
|
||||
);
|
||||
println!(" psu={:?}", data.psu);
|
||||
println!(" tuning_percent={:?}", data.tuning_percent);
|
||||
println!(" tuning_target={:?}", data.tuning_target);
|
||||
match &data.tuning_capabilities {
|
||||
Some(c) => {
|
||||
println!(" caps.power={:?}", c.power);
|
||||
println!(" caps.hashrate={:?}", c.hashrate);
|
||||
match &c.presets {
|
||||
Some(p) => {
|
||||
println!(" caps.presets.default={:?}", p.default);
|
||||
println!(" caps.presets[{}]:", p.presets.len());
|
||||
for t in &p.presets {
|
||||
println!(" - {t:?}");
|
||||
}
|
||||
}
|
||||
None => println!(" caps.presets=None"),
|
||||
}
|
||||
}
|
||||
None => println!(" tuning_capabilities=None"),
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// WRITE (reversible): apply a structured tuning target via set_tuning_config.
|
||||
/// `settune <ip> power <watts>` or `settune <ip> hashrate <ths>`. Prints the
|
||||
/// prior target so the caller can restore it. Used to verify the set_tuning_config
|
||||
/// path on live corpus hardware (round 17 C) before wiring it into the GUI.
|
||||
async fn settune(ip_s: &str, kind: &str, value: f64) {
|
||||
use asic_rs::core::config::tuning::TuningConfig;
|
||||
use asic_rs::core::data::hashrate::HashRateUnit;
|
||||
use asic_rs::core::data::miner::TuningTarget;
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let before = m.get_data().await;
|
||||
eprintln!(
|
||||
"target {ip}: {} {} {} (supports_tuning_config={}); prior target = {:?}",
|
||||
before.device_info.make,
|
||||
before.device_info.firmware,
|
||||
before.device_info.model,
|
||||
m.supports_tuning_config(),
|
||||
before.tuning_target,
|
||||
);
|
||||
let target = match kind {
|
||||
"power" => TuningTarget::Power(Power::from_watts(value)),
|
||||
// Clone the miner's current HashRate to inherit its algorithm
|
||||
// (HashAlgorithm is not publicly re-exported, so it cannot be named
|
||||
// directly), overriding just the value and unit.
|
||||
"hashrate" => match before.hashrate.clone() {
|
||||
Some(mut hr) => {
|
||||
hr.value = value;
|
||||
hr.unit = HashRateUnit::TeraHash;
|
||||
TuningTarget::HashRate(hr)
|
||||
}
|
||||
None => {
|
||||
eprintln!("miner reports no current hashrate; cannot build a hashrate target");
|
||||
return;
|
||||
}
|
||||
},
|
||||
_ => {
|
||||
eprintln!("kind must be 'power' or 'hashrate'");
|
||||
return;
|
||||
}
|
||||
};
|
||||
// Route by what the firmware actually supports: structured
|
||||
// set_tuning_config where available (ePIC/VNish/WM), else the plain
|
||||
// power-limit setter for a power target (LuxOS/Braiins tune by power
|
||||
// and expose no set_tuning_config).
|
||||
if m.supports_tuning_config() {
|
||||
// Mirror the GUI apply path: preserve the firmware's current tuning
|
||||
// algorithm + scaling (ePIC requires both for set_tuning_config).
|
||||
let mut cfg = TuningConfig::new(target);
|
||||
if let Some(algo) = m.get_tuning_config().await.ok().and_then(|c| c.algorithm) {
|
||||
cfg = cfg.with_algorithm(algo);
|
||||
}
|
||||
let scaling = m.get_scaling_config().await.ok();
|
||||
match m.set_tuning_config(cfg, scaling).await {
|
||||
Ok(v) => println!("set_tuning_config({kind} {value}) -> Ok({v})"),
|
||||
Err(e) => println!("set_tuning_config({kind} {value}) -> Err: {e:#}"),
|
||||
}
|
||||
} else if kind == "power" && m.supports_set_power_limit() {
|
||||
match m.set_power_limit(Power::from_watts(value)).await {
|
||||
Ok(v) => println!("set_power_limit({value} W) -> Ok({v}) [tuning_config unsupported]"),
|
||||
Err(e) => println!("set_power_limit({value} W) -> Err: {e:#}"),
|
||||
}
|
||||
} else {
|
||||
println!("no structured-tuning path for {kind} on this firmware");
|
||||
}
|
||||
let after = m.get_data().await;
|
||||
println!(" target now = {:?}", after.tuning_target);
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// READ: list the firmware's selectable profiles/presets (roadmap G3).
|
||||
async fn presets(ip_s: &str) {
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
if !m.supports_presets() {
|
||||
println!("{ip}: firmware does not expose named presets");
|
||||
return;
|
||||
}
|
||||
let list = m.get_presets().await;
|
||||
if list.is_empty() {
|
||||
println!("{ip}: no presets reported");
|
||||
return;
|
||||
}
|
||||
for p in list {
|
||||
match (p.pretty, p.status) {
|
||||
(Some(pretty), Some(status)) => println!("{}\t{pretty}\t[{status}]", p.name),
|
||||
(Some(pretty), None) => println!("{}\t{pretty}", p.name),
|
||||
(None, _) => println!("{}", p.name),
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// WRITE (reversible): select a named firmware profile/preset (roadmap G3).
|
||||
/// `setpreset <ip> <name>`. Prints the prior target so it can be restored.
|
||||
async fn setpreset(ip_s: &str, name: &str) {
|
||||
use asic_rs::core::config::tuning::TuningConfig;
|
||||
use asic_rs::core::data::miner::TuningTarget;
|
||||
let ip: std::net::IpAddr = match ip_s.parse() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => {
|
||||
eprintln!("bad ip {ip_s}: {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
let f = factory();
|
||||
match f.scan_miner(ip).await {
|
||||
Ok(Some(m)) => {
|
||||
let before = m.get_data().await;
|
||||
eprintln!(
|
||||
"target {ip}: {} {} {} (supports_presets={}); prior target = {:?}",
|
||||
before.device_info.make,
|
||||
before.device_info.firmware,
|
||||
before.device_info.model,
|
||||
m.supports_presets(),
|
||||
before.tuning_target,
|
||||
);
|
||||
let cfg = TuningConfig::new(TuningTarget::Preset(name.to_string()));
|
||||
match m.set_tuning_config(cfg, None).await {
|
||||
Ok(v) => println!("set_tuning_config(preset {name}) -> Ok({v})"),
|
||||
Err(e) => println!("set_tuning_config(preset {name}) -> Err: {e:#}"),
|
||||
}
|
||||
let after = m.get_data().await;
|
||||
println!(" target now = {:?}", after.tuning_target);
|
||||
}
|
||||
Ok(None) => eprintln!("no miner at {ip}"),
|
||||
Err(e) => eprintln!("scan_miner {ip}: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let args: Vec<String> = std::env::args().collect();
|
||||
let rt = match tokio::runtime::Builder::new_current_thread().enable_all().build() {
|
||||
Ok(rt) => rt,
|
||||
Err(e) => {
|
||||
eprintln!("tokio runtime: {e}");
|
||||
std::process::exit(2);
|
||||
}
|
||||
};
|
||||
match args.get(1).map(String::as_str) {
|
||||
Some("scan") if args.len() >= 3 => rt.block_on(scan(&args[2..])),
|
||||
Some("hashrate") if args.len() >= 3 => rt.block_on(hashrate(&args[2..])),
|
||||
Some("setpl") if args.len() == 4 => {
|
||||
let watts: f64 = args[3].parse().unwrap_or(-1.0);
|
||||
if watts <= 0.0 {
|
||||
eprintln!("watts must be a positive number");
|
||||
std::process::exit(2);
|
||||
}
|
||||
rt.block_on(setpl(&args[2], watts));
|
||||
}
|
||||
Some("led") if args.len() == 3 => rt.block_on(led(&args[2])),
|
||||
Some("light") if args.len() == 4 && matches!(args[3].as_str(), "on" | "off") => {
|
||||
rt.block_on(light(&args[2], args[3] == "on"))
|
||||
}
|
||||
Some(v @ ("restart" | "pause" | "resume")) if args.len() == 3 => {
|
||||
rt.block_on(lifecycle(&args[2], v))
|
||||
}
|
||||
Some("setpools") if args.len() == 6 => {
|
||||
rt.block_on(setpools(&args[2], &args[3], &args[4], &args[5]))
|
||||
}
|
||||
Some("msgs") if args.len() == 3 => rt.block_on(msgs(&args[2])),
|
||||
Some("tune") if args.len() == 3 => rt.block_on(tune(&args[2])),
|
||||
Some("presets") if args.len() == 3 => rt.block_on(presets(&args[2])),
|
||||
Some("setpreset") if args.len() == 4 => rt.block_on(setpreset(&args[2], &args[3])),
|
||||
Some("settune") if args.len() == 5 && matches!(args[3].as_str(), "power" | "hashrate") => {
|
||||
let value: f64 = args[4].parse().unwrap_or(-1.0);
|
||||
if value <= 0.0 {
|
||||
eprintln!("value must be a positive number");
|
||||
std::process::exit(2);
|
||||
}
|
||||
rt.block_on(settune(&args[2], &args[3], value));
|
||||
}
|
||||
Some("timezone") if args.len() == 3 => rt.block_on(timezone(&args[2], None)),
|
||||
Some("timezone") if args.len() == 4 => rt.block_on(timezone(&args[2], Some(&args[3]))),
|
||||
Some("passwd") if args.len() == 4 => rt.block_on(passwd(&args[2], &args[3])),
|
||||
Some("factoryreset") if args.len() == 3 => rt.block_on(factoryreset(&args[2])),
|
||||
_ => {
|
||||
eprintln!(
|
||||
"miner_probe -- asic-rs config + scan CLI for the alkane-toolkit fleet\n\
|
||||
\n\
|
||||
READ (safe on any miner):\n\
|
||||
\x20 scan <cidr> [<cidr>...] discover + telemetry (TSV)\n\
|
||||
\x20 hashrate <cidr> [<cidr>...] raw hashrate/algo dump\n\
|
||||
\x20 msgs <ip> structured faults + per-board data\n\
|
||||
\x20 tune <ip> structured-tuning support + capability envelope\n\
|
||||
\x20 presets <ip> list selectable firmware profiles/presets\n\
|
||||
\n\
|
||||
WRITE (MUTATES the miner -- use the test-bed miners, not production):\n\
|
||||
\x20 light <ip> <on|off> set the locate light\n\
|
||||
\x20 led <ip> toggle locate light on then off (reversible test)\n\
|
||||
\x20 pause <ip> pause mining\n\
|
||||
\x20 resume <ip> resume mining\n\
|
||||
\x20 restart <ip> restart/reboot\n\
|
||||
\x20 setpl <ip> <watts> set power limit\n\
|
||||
\x20 settune <ip> <power|hashrate> <v> set a structured tuning target (prints prior)\n\
|
||||
\x20 setpreset <ip> <name> select a named firmware profile/preset (prints prior)\n\
|
||||
\x20 setpools <ip> <url> <user> <pass> set the default pool group\n\
|
||||
\x20 timezone <ip> [<IANA>] read (no arg) or set the timezone\n\
|
||||
\x20 passwd <ip> <newpass> change the web/API password (DANGEROUS)\n\
|
||||
\x20 factoryreset <ip> factory reset (DESTRUCTIVE; sacrificial units only)\n\
|
||||
\n\
|
||||
Each write verb is capability-gated (skips miners that do not support it).\n\
|
||||
Credentials: ALKANE_PROBE_USER/PASS or ~/.config/alkane-toolkit/scan-credentials.txt."
|
||||
);
|
||||
std::process::exit(2);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,300 @@
|
||||
//! Optional saved miner credentials, applied to every asic-rs discovery call.
|
||||
//!
|
||||
//! asic-rs has no single global credential field on `MinerFactory`: auth is set
|
||||
//! per firmware backend via `with_firmware_discovery_auth`. `configured_factory`
|
||||
//! is the one place that fans a saved username/password out across the whole
|
||||
//! firmware registry, so `scan`'s callers never have to think about it.
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::io::Write;
|
||||
use std::os::unix::fs::{OpenOptionsExt, PermissionsExt};
|
||||
|
||||
use asic_rs::MinerFactory;
|
||||
use asic_rs::core::traits::miner::MinerAuth;
|
||||
|
||||
use crate::scan::config_path;
|
||||
|
||||
pub const CREDENTIALS_FILE: &str = "scan-credentials.txt";
|
||||
/// Per-firmware default logins the operator can override (round 12 #13). One
|
||||
/// `firmware-name<TAB>user<TAB>pass` line per firmware, 0600 like the others.
|
||||
/// Keyed by the firmware registry's Display name (see `firmware_default_creds`).
|
||||
pub const FIRMWARE_CREDENTIALS_FILE: &str = "firmware-credentials.txt";
|
||||
/// SSH login for the control board (used by the PIC probe; distinct from the
|
||||
/// web/API scan credentials above -- miners' SSH root login is usually not the
|
||||
/// same account as the web digest-auth login).
|
||||
pub const SSH_CREDENTIALS_FILE: &str = "ssh-credentials.txt";
|
||||
|
||||
/// Load a saved username/password pair from `file`, if present.
|
||||
fn load_creds_file(file: &str) -> Option<(String, String)> {
|
||||
let s = std::fs::read_to_string(config_path(file)).ok()?;
|
||||
let mut lines = s.lines();
|
||||
let user = lines.next()?.to_string();
|
||||
let pass = lines.next().unwrap_or("").to_string();
|
||||
Some((user, pass))
|
||||
}
|
||||
|
||||
/// Save a username/password pair to `file`, restricting it to owner read/write
|
||||
/// (credentials are plaintext on disk, so the mode matters).
|
||||
fn save_creds_file(file: &str, user: &str, pass: &str) -> std::io::Result<()> {
|
||||
let p = config_path(file);
|
||||
if let Some(dir) = p.parent() {
|
||||
std::fs::create_dir_all(dir)?;
|
||||
}
|
||||
// Open (and create) with mode 0600 up front so a freshly created file is
|
||||
// never world/group-readable, even for the instant before the write. For a
|
||||
// pre-existing file the create mode is ignored, so also tighten it to 0600
|
||||
// while it is still empty (post-truncate, pre-write) -- the plaintext is
|
||||
// never on disk under a looser mode.
|
||||
let mut f = std::fs::OpenOptions::new()
|
||||
.write(true)
|
||||
.create(true)
|
||||
.truncate(true)
|
||||
.mode(0o600)
|
||||
.open(&p)?;
|
||||
f.set_permissions(std::fs::Permissions::from_mode(0o600))?;
|
||||
f.write_all(format!("{user}\n{pass}\n").as_bytes())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn clear_creds_file(file: &str) -> std::io::Result<()> {
|
||||
match std::fs::remove_file(config_path(file)) {
|
||||
Ok(()) => Ok(()),
|
||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(()),
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
}
|
||||
|
||||
/// Load the saved miner web/API username/password, if any were saved.
|
||||
pub fn load_credentials() -> Option<(String, String)> {
|
||||
load_creds_file(CREDENTIALS_FILE)
|
||||
}
|
||||
|
||||
/// Save the miner web/API username/password (0600).
|
||||
pub fn save_credentials(user: &str, pass: &str) -> std::io::Result<()> {
|
||||
save_creds_file(CREDENTIALS_FILE, user, pass)
|
||||
}
|
||||
|
||||
/// Load the saved SSH username/password (used by the Braiins restore-to-stock
|
||||
/// flow), if any.
|
||||
pub fn load_ssh_credentials() -> Option<(String, String)> {
|
||||
load_creds_file(SSH_CREDENTIALS_FILE)
|
||||
}
|
||||
|
||||
/// Save the SSH username/password (0600). Retained for a future SSH-login dialog
|
||||
/// now that the SSH PIC probe that used to save it has been removed (round 14 #5).
|
||||
#[allow(dead_code)]
|
||||
pub fn save_ssh_credentials(user: &str, pass: &str) -> std::io::Result<()> {
|
||||
save_creds_file(SSH_CREDENTIALS_FILE, user, pass)
|
||||
}
|
||||
|
||||
/// Remove the saved web/API credentials, if any. Not an error if none were saved.
|
||||
pub fn clear_credentials() -> std::io::Result<()> {
|
||||
match clear_creds_file(CREDENTIALS_FILE) {
|
||||
Ok(()) => Ok(()),
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
}
|
||||
|
||||
/// The stock/default login each firmware ships with, keyed by the firmware
|
||||
/// registry's Display name (round 12 #13). These seed the per-firmware editor and
|
||||
/// let it tell an override from an unchanged default; they mirror the
|
||||
/// `default_auth()` constants in the vendored asic-rs backends (a single
|
||||
/// best-guess per registry entry, since a stock entry can span several backend
|
||||
/// versions). asic-rs does not expose these at the entry level, so they are
|
||||
/// duplicated here; a firmware absent from this table defaults to blank.
|
||||
pub fn firmware_default_creds() -> &'static [(&'static str, &'static str, &'static str)] {
|
||||
&[
|
||||
("AntMiner Stock", "root", "root"),
|
||||
("WhatsMiner Stock", "admin", "admin"),
|
||||
("Braiins", "root", "root"),
|
||||
("VNish", "", "admin"),
|
||||
("LuxOS", "root", "root"),
|
||||
("UMC OS", "", "letmein"),
|
||||
("Marathon", "root", "root"),
|
||||
("VolcMiner Stock", "root", "ltc@dog"),
|
||||
("Elphapex Stock", "root", "root"),
|
||||
("FutureBit Stock", "futurebit", "futurebit123"),
|
||||
("SealMiner Stock", "seal", "seal"),
|
||||
("Auradine Stock", "admin", "admin"),
|
||||
("AvalonMiner Stock", "", ""),
|
||||
("Nerdaxe Stock", "", ""),
|
||||
("Proto Stock", "", ""),
|
||||
("Bitaxe Stock", "", ""),
|
||||
]
|
||||
}
|
||||
|
||||
/// The shipped default login for a firmware, or `("","")` if unknown.
|
||||
pub fn firmware_default_for(name: &str) -> (String, String) {
|
||||
firmware_default_creds()
|
||||
.iter()
|
||||
.find(|(n, _, _)| *n == name)
|
||||
.map(|(_, u, p)| (u.to_string(), p.to_string()))
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
/// Load the operator's per-firmware credential overrides, keyed by firmware
|
||||
/// Display name. Malformed lines are skipped.
|
||||
pub fn load_firmware_credentials() -> HashMap<String, (String, String)> {
|
||||
let mut map = HashMap::new();
|
||||
let Ok(s) = std::fs::read_to_string(config_path(FIRMWARE_CREDENTIALS_FILE)) else {
|
||||
return map;
|
||||
};
|
||||
for line in s.lines() {
|
||||
let mut parts = line.splitn(3, '\t');
|
||||
let (Some(name), user) = (parts.next(), parts.next()) else {
|
||||
continue;
|
||||
};
|
||||
if name.is_empty() {
|
||||
continue;
|
||||
}
|
||||
let user = user.unwrap_or("").to_string();
|
||||
let pass = parts.next().unwrap_or("").to_string();
|
||||
map.insert(name.to_string(), (user, pass));
|
||||
}
|
||||
map
|
||||
}
|
||||
|
||||
/// Save the per-firmware credential overrides (0600), sorted by name for a
|
||||
/// stable file. An empty map clears the file.
|
||||
pub fn save_firmware_credentials(map: &HashMap<String, (String, String)>) -> std::io::Result<()> {
|
||||
if map.is_empty() {
|
||||
return clear_firmware_credentials();
|
||||
}
|
||||
let p = config_path(FIRMWARE_CREDENTIALS_FILE);
|
||||
if let Some(dir) = p.parent() {
|
||||
std::fs::create_dir_all(dir)?;
|
||||
}
|
||||
let mut f = std::fs::OpenOptions::new()
|
||||
.write(true)
|
||||
.create(true)
|
||||
.truncate(true)
|
||||
.mode(0o600)
|
||||
.open(&p)?;
|
||||
f.set_permissions(std::fs::Permissions::from_mode(0o600))?;
|
||||
let mut names: Vec<&String> = map.keys().collect();
|
||||
names.sort();
|
||||
for name in names {
|
||||
let (user, pass) = &map[name];
|
||||
f.write_all(format!("{name}\t{user}\t{pass}\n").as_bytes())?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Remove the per-firmware overrides file, if any. Not an error if none exists.
|
||||
pub fn clear_firmware_credentials() -> std::io::Result<()> {
|
||||
clear_creds_file(FIRMWARE_CREDENTIALS_FILE)
|
||||
}
|
||||
|
||||
/// Build a `MinerFactory` with saved credentials applied as discovery auth.
|
||||
/// Precedence per firmware backend: a per-firmware override (round 12 #13) wins;
|
||||
/// otherwise the single global scan credential (if set) applies to every backend;
|
||||
/// otherwise the backend falls back to its own default auth. With nothing saved
|
||||
/// this is plain `MinerFactory::new()`.
|
||||
pub fn configured_factory() -> MinerFactory {
|
||||
// Apply the operator's configured identification timeout to every factory
|
||||
// (round 18 #12: config actions / refresh / pools / flash previously used
|
||||
// asic-rs's 10s default, so on a slow link they could fail to reach miners a
|
||||
// longer-timeout scan had found). start_scan may still override it explicitly.
|
||||
let mut factory =
|
||||
MinerFactory::new().with_identification_timeout_secs(crate::scan::load_scan_timeout().max(1));
|
||||
let global = load_credentials();
|
||||
let per_fw = load_firmware_credentials();
|
||||
if global.is_none() && per_fw.is_empty() {
|
||||
return factory;
|
||||
}
|
||||
for fw in asic_rs::factory::default_firmware_registry() {
|
||||
let cred = per_fw
|
||||
.get(&fw.to_string())
|
||||
.cloned()
|
||||
.or_else(|| global.clone());
|
||||
if let Some((user, pass)) = cred {
|
||||
factory = factory.with_firmware_discovery_auth(fw.as_ref(), MinerAuth::new(user, pass));
|
||||
}
|
||||
}
|
||||
factory
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn credentials_round_trip_and_file_perms() {
|
||||
// config_path() reads $HOME; point it at a private temp dir. HOME is
|
||||
// process-global, so serialise against other HOME-mutating tests via the
|
||||
// shared lock and restore HOME afterward (round 18 #12).
|
||||
let _home = crate::model::HOME_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let prev = std::env::var_os("HOME");
|
||||
let dir = std::env::temp_dir().join(format!("alkane-cred-test-{}", std::process::id()));
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
std::fs::create_dir_all(&dir).unwrap();
|
||||
std::env::set_var("HOME", &dir);
|
||||
|
||||
assert_eq!(load_credentials(), None, "no file -> None");
|
||||
|
||||
save_credentials("admin", "hunter2").unwrap();
|
||||
assert_eq!(load_credentials(), Some(("admin".to_string(), "hunter2".to_string())));
|
||||
|
||||
let meta = std::fs::metadata(config_path(CREDENTIALS_FILE)).unwrap();
|
||||
assert_eq!(meta.permissions().mode() & 0o777, 0o600, "credentials file must be 0600");
|
||||
|
||||
// configured_factory() must construct in both branches without panicking:
|
||||
// with saved credentials (fans auth across every firmware backend) ...
|
||||
let _ = configured_factory();
|
||||
|
||||
// A pre-existing, world-readable credentials file must be tightened to
|
||||
// 0600 by save_credentials (the create-mode is ignored for an existing
|
||||
// file, so the explicit set_permissions is what protects it).
|
||||
let path = config_path(CREDENTIALS_FILE);
|
||||
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o644)).unwrap();
|
||||
save_credentials("admin2", "s3cr3t").unwrap();
|
||||
let meta = std::fs::metadata(&path).unwrap();
|
||||
assert_eq!(
|
||||
meta.permissions().mode() & 0o777,
|
||||
0o600,
|
||||
"save over a pre-existing 0644 file must re-tighten to 0600"
|
||||
);
|
||||
assert_eq!(load_credentials(), Some(("admin2".to_string(), "s3cr3t".to_string())));
|
||||
|
||||
clear_credentials().unwrap();
|
||||
// ... and with no saved credentials (plain MinerFactory::new()).
|
||||
let _ = configured_factory();
|
||||
assert_eq!(load_credentials(), None, "cleared -> None");
|
||||
clear_credentials().unwrap(); // idempotent: clearing an already-clear store is not an error
|
||||
|
||||
// Per-firmware overrides (round 12 #13). Kept in this same test because
|
||||
// HOME is process-global: a second #[test] mutating it would race under
|
||||
// cargo's default parallel runner.
|
||||
assert!(load_firmware_credentials().is_empty(), "no file -> empty map");
|
||||
let mut fw = HashMap::new();
|
||||
fw.insert("WhatsMiner Stock".to_string(), ("super".to_string(), "sup3r".to_string()));
|
||||
fw.insert("VNish".to_string(), ("".to_string(), "hunter2".to_string()));
|
||||
save_firmware_credentials(&fw).unwrap();
|
||||
// 0600, and it round-trips (an empty username survives the tab format).
|
||||
let fwpath = config_path(FIRMWARE_CREDENTIALS_FILE);
|
||||
assert_eq!(
|
||||
std::fs::metadata(&fwpath).unwrap().permissions().mode() & 0o777,
|
||||
0o600,
|
||||
"per-firmware creds file must be 0600"
|
||||
);
|
||||
let back = load_firmware_credentials();
|
||||
assert_eq!(back.get("WhatsMiner Stock"), Some(&("super".into(), "sup3r".into())));
|
||||
assert_eq!(back.get("VNish"), Some(&("".into(), "hunter2".into())));
|
||||
assert_eq!(back.len(), 2);
|
||||
// Shipped-default lookup: known firmware resolves, unknown blanks.
|
||||
assert_eq!(firmware_default_for("AntMiner Stock"), ("root".into(), "root".into()));
|
||||
assert_eq!(firmware_default_for("nonexistent"), (String::new(), String::new()));
|
||||
// Overrides + no global still builds a factory.
|
||||
let _ = configured_factory();
|
||||
// Saving an empty map clears the file (no stale overrides linger).
|
||||
save_firmware_credentials(&HashMap::new()).unwrap();
|
||||
assert!(load_firmware_credentials().is_empty(), "empty save -> cleared");
|
||||
clear_firmware_credentials().unwrap(); // idempotent
|
||||
|
||||
match prev {
|
||||
Some(v) => std::env::set_var("HOME", v),
|
||||
None => std::env::remove_var("HOME"),
|
||||
}
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,246 @@
|
||||
//! CSV export of the full scan data (round 15 #14).
|
||||
//!
|
||||
//! Unlike the on-screen table (which packs several values into one cell, e.g.
|
||||
//! "95T/96T" or a row of health icons), the export is one value per cell and
|
||||
//! covers every scanned data point, so it is complete and machine-readable.
|
||||
//! Variable-length fields (per-board temps, per-fan RPMs, per-board health, the
|
||||
//! pool list) are expanded into indexed columns out to the widest miner in the
|
||||
//! set, so every row has the same columns.
|
||||
|
||||
use crate::model::{BoardHealth, MinerRow};
|
||||
|
||||
/// A compact UTC timestamp "YYYYMMDD-HHMMSS" for a default export filename
|
||||
/// (round 19 #5). UTC keeps this dependency-free (no chrono) and unambiguous.
|
||||
pub fn timestamp_utc() -> String {
|
||||
let secs = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.map(|d| d.as_secs())
|
||||
.unwrap_or(0);
|
||||
let sod = secs % 86_400;
|
||||
let (h, mi, s) = (sod / 3600, (sod % 3600) / 60, sod % 60);
|
||||
// Civil date from days since 1970-01-01 (Howard Hinnant's civil_from_days).
|
||||
let z = (secs / 86_400) as i64 + 719_468;
|
||||
let era = if z >= 0 { z } else { z - 146_096 } / 146_097;
|
||||
let doe = z - era * 146_097; // [0, 146096]
|
||||
let yoe = (doe - doe / 1460 + doe / 36_524 - doe / 146_096) / 365; // [0, 399]
|
||||
let doy = doe - (365 * yoe + yoe / 4 - yoe / 100); // [0, 365]
|
||||
let mp = (5 * doy + 2) / 153; // [0, 11]
|
||||
let d = doy - (153 * mp + 2) / 5 + 1; // [1, 31]
|
||||
let m = if mp < 10 { mp + 3 } else { mp - 9 }; // [1, 12]
|
||||
let y = yoe + era * 400 + i64::from(m <= 2);
|
||||
format!("{y:04}{m:02}{d:02}-{h:02}{mi:02}{s:02}")
|
||||
}
|
||||
|
||||
/// Escape one CSV field: neutralise spreadsheet formula injection, then quote it
|
||||
/// when it contains a comma, quote, CR or LF (doubling any embedded quotes).
|
||||
///
|
||||
/// Miner-supplied fields (hostname, worker, serial, ...) can start with a formula
|
||||
/// trigger; prefixing a single quote makes Excel/Sheets treat the cell as text so
|
||||
/// opening the export can't execute an injected formula (round 18 #12).
|
||||
fn esc(s: &str) -> String {
|
||||
let mut val = s.to_string();
|
||||
if val.starts_with(['=', '+', '-', '@', '\t', '\r']) {
|
||||
val.insert(0, '\'');
|
||||
}
|
||||
if val.contains([',', '"', '\n', '\r']) {
|
||||
format!("\"{}\"", val.replace('"', "\"\""))
|
||||
} else {
|
||||
val
|
||||
}
|
||||
}
|
||||
|
||||
fn num(v: f64) -> String {
|
||||
if v == 0.0 {
|
||||
String::new()
|
||||
} else if v.fract() == 0.0 {
|
||||
format!("{v:.0}")
|
||||
} else {
|
||||
format!("{v:.3}")
|
||||
}
|
||||
}
|
||||
|
||||
fn opt_bool(v: Option<bool>, yes: &str, no: &str) -> String {
|
||||
match v {
|
||||
Some(true) => yes.to_string(),
|
||||
Some(false) => no.to_string(),
|
||||
None => String::new(),
|
||||
}
|
||||
}
|
||||
|
||||
fn board_health_str(h: &BoardHealth) -> &'static str {
|
||||
match h {
|
||||
BoardHealth::Ok => "ok",
|
||||
BoardHealth::Fault => "fault",
|
||||
BoardHealth::Missing => "missing",
|
||||
}
|
||||
}
|
||||
|
||||
/// The fixed scalar columns, in order: (header, extractor).
|
||||
type Col = (&'static str, fn(&MinerRow) -> String);
|
||||
|
||||
fn scalar_columns() -> Vec<Col> {
|
||||
vec![
|
||||
("ip", |r| r.ip.clone()),
|
||||
("model", |r| r.model.clone()),
|
||||
("brand", |r| r.brand.clone()),
|
||||
("submodel", |r| r.submodel.clone()),
|
||||
("mac", |r| r.mac.clone()),
|
||||
("hostname", |r| r.hostname.clone()),
|
||||
("serial", |r| r.serial.clone()),
|
||||
("firmware", |r| r.firmware.clone()),
|
||||
("fw_version", |r| r.fw_version.clone()),
|
||||
("api_version", |r| r.api_version.clone()),
|
||||
("control_board", |r| r.control_board.clone()),
|
||||
("cpu", |r| r.cpu.clone()),
|
||||
("board_code", |r| r.board_code.clone()),
|
||||
("algorithm", |r| r.algorithm.clone()),
|
||||
("status", |r| r.status().to_string()),
|
||||
("operating_state", |r| r.operating_state.clone()),
|
||||
("is_mining", |r| r.is_mining.to_string()),
|
||||
("slow", |r| r.slow.to_string()),
|
||||
("paused", |r| r.paused.to_string()),
|
||||
("pic", |r| opt_bool(r.pic_present, "PIC", "noPIC")),
|
||||
("write_locked", |r| opt_bool(r.write_locked, "locked", "unlocked")),
|
||||
("light_flashing", |r| opt_bool(r.light_flashing, "on", "off")),
|
||||
("hashrate_ths", |r| num(r.hashrate_ths)),
|
||||
("expected_ths", |r| num(r.expected_ths)),
|
||||
("efficiency_j_th", |r| num(r.efficiency)),
|
||||
("power_w", |r| num(r.power_w)),
|
||||
("tuning_percent", |r| r.tuning_percent.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("chip_temp_c", |r| num(r.chip_temp_c)),
|
||||
("fluid_temp_c", |r| num(r.fluid_temp_c)),
|
||||
("env_temp_c", |r| num(r.env_temp_c)),
|
||||
("outlet_temp_c", |r| num(r.outlet_temp_c)),
|
||||
("psu_fan_rpm", |r| num(r.psu_fan_rpm)),
|
||||
("fan_count", |r| r.fan_count.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("expected_fans", |r| r.expected_fans.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("total_chips", |r| r.total_chips.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("expected_chips", |r| r.expected_chips.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("hashboards", |r| r.hashboards.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("expected_hashboards", |r| r.expected_hashboards.map(|v| v.to_string()).unwrap_or_default()),
|
||||
("uptime_secs", |r| if r.uptime_secs > 0 { r.uptime_secs.to_string() } else { String::new() }),
|
||||
("best_share", |r| r.best_share.map(num).unwrap_or_default()),
|
||||
("session_best_share", |r| r.session_best_share.map(num).unwrap_or_default()),
|
||||
("pool_account", |r| r.worker.split_once('.').map(|(a, _)| a).unwrap_or(&r.worker).to_string()),
|
||||
("pool_url", |r| r.pool_url.clone()),
|
||||
("errors", |r| r.errors.join("; ")),
|
||||
]
|
||||
}
|
||||
|
||||
// Group keys for the four variable-length field families (each expands to
|
||||
// per-index columns). Shown as single checkboxes in the export picker (round 19 #6).
|
||||
pub const GROUP_BOARD_TEMPS: &str = "board temps";
|
||||
pub const GROUP_FANS: &str = "fan rpms";
|
||||
pub const GROUP_BOARD_STATUS: &str = "board status";
|
||||
pub const GROUP_POOLS: &str = "pools";
|
||||
|
||||
/// Every selectable export field, in output order: each scalar column header,
|
||||
/// then the four variable-length group keys.
|
||||
pub fn export_field_names() -> Vec<String> {
|
||||
let mut v: Vec<String> = scalar_columns().iter().map(|(h, _)| (*h).to_string()).collect();
|
||||
v.push(GROUP_BOARD_TEMPS.to_string());
|
||||
v.push(GROUP_FANS.to_string());
|
||||
v.push(GROUP_BOARD_STATUS.to_string());
|
||||
v.push(GROUP_POOLS.to_string());
|
||||
v
|
||||
}
|
||||
|
||||
/// Build the CSV for `rows` including only the selected fields (scalar column
|
||||
/// headers and/or the group keys above), in the fixed output order (round 19 #6).
|
||||
/// Empty rows still emit a header line.
|
||||
pub fn rows_to_csv_selected(
|
||||
rows: &[MinerRow],
|
||||
selected: &std::collections::HashSet<String>,
|
||||
) -> String {
|
||||
let cols: Vec<Col> =
|
||||
scalar_columns().into_iter().filter(|(h, _)| selected.contains(*h)).collect();
|
||||
// A group's columns appear only when it is selected; an unselected group's
|
||||
// width stays 0, so the header/value loops below emit nothing for it.
|
||||
let width = |want: bool, f: &dyn Fn(&MinerRow) -> usize| -> usize {
|
||||
if want { rows.iter().map(f).max().unwrap_or(0) } else { 0 }
|
||||
};
|
||||
let max_board_temps = width(selected.contains(GROUP_BOARD_TEMPS), &|r| r.board_temps.len());
|
||||
let max_fans = width(selected.contains(GROUP_FANS), &|r| r.fan_rpms.len());
|
||||
let max_boards = width(selected.contains(GROUP_BOARD_STATUS), &|r| r.board_status.len());
|
||||
let max_pools = width(selected.contains(GROUP_POOLS), &|r| r.pools.len());
|
||||
|
||||
// Header.
|
||||
let mut headers: Vec<String> = cols.iter().map(|(h, _)| (*h).to_string()).collect();
|
||||
for i in 1..=max_board_temps {
|
||||
headers.push(format!("board_temp_{i}_c"));
|
||||
}
|
||||
for i in 1..=max_fans {
|
||||
headers.push(format!("fan_{i}_rpm"));
|
||||
}
|
||||
for i in 1..=max_boards {
|
||||
headers.push(format!("board_{i}_status"));
|
||||
}
|
||||
for i in 1..=max_pools {
|
||||
headers.push(format!("pool_{i}_url"));
|
||||
headers.push(format!("pool_{i}_worker"));
|
||||
}
|
||||
|
||||
let mut out = String::new();
|
||||
out.push_str(&headers.iter().map(|h| esc(h)).collect::<Vec<_>>().join(","));
|
||||
out.push('\n');
|
||||
|
||||
for r in rows {
|
||||
let mut vals: Vec<String> = cols.iter().map(|(_, f)| f(r)).collect();
|
||||
for i in 0..max_board_temps {
|
||||
vals.push(r.board_temps.get(i).map(|&t| num(t)).unwrap_or_default());
|
||||
}
|
||||
for i in 0..max_fans {
|
||||
vals.push(r.fan_rpms.get(i).map(|&t| num(t)).unwrap_or_default());
|
||||
}
|
||||
for i in 0..max_boards {
|
||||
vals.push(r.board_status.get(i).map(board_health_str).unwrap_or("").to_string());
|
||||
}
|
||||
for i in 0..max_pools {
|
||||
let (u, w) = r.pools.get(i).cloned().unwrap_or_default();
|
||||
vals.push(u);
|
||||
vals.push(w);
|
||||
}
|
||||
out.push_str(&vals.iter().map(|v| esc(v)).collect::<Vec<_>>().join(","));
|
||||
out.push('\n');
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn csv_has_header_and_one_row_per_miner() {
|
||||
let rows = vec![
|
||||
MinerRow {
|
||||
ip: "10.0.0.1".into(),
|
||||
model: "S19".into(),
|
||||
hashrate_ths: 95.0,
|
||||
expected_ths: 96.0,
|
||||
board_temps: vec![77.0, 64.0, 74.0],
|
||||
fan_rpms: vec![6000.0, 6100.0],
|
||||
..Default::default()
|
||||
},
|
||||
MinerRow { ip: "10.0.0.2".into(), model: "M30S".into(), ..Default::default() },
|
||||
];
|
||||
let all: std::collections::HashSet<String> = export_field_names().into_iter().collect();
|
||||
let csv = rows_to_csv_selected(&rows, &all);
|
||||
let lines: Vec<&str> = csv.lines().collect();
|
||||
assert_eq!(lines.len(), 3, "header + 2 rows");
|
||||
assert!(lines[0].starts_with("ip,model,brand,"));
|
||||
// Expanded columns out to the widest miner (3 board temps, 2 fans).
|
||||
assert!(lines[0].contains("board_temp_3_c"));
|
||||
assert!(lines[0].contains("fan_2_rpm"));
|
||||
assert!(lines[1].starts_with("10.0.0.1,S19,"));
|
||||
// One value per cell: hashrate and expected are separate columns.
|
||||
assert!(lines[1].contains(",95,96,") || lines[1].contains("95,96"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn csv_escapes_commas_and_quotes() {
|
||||
assert_eq!(esc("a,b"), "\"a,b\"");
|
||||
assert_eq!(esc("he said \"hi\""), "\"he said \"\"hi\"\"\"");
|
||||
assert_eq!(esc("plain"), "plain");
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,8 @@
|
||||
//! 10.255.1.0/24 (see ../../../HANDOFF.md section 7 and the parent project's
|
||||
//! [removed]). These are the reference values the workflow tests compare
|
||||
//! the application's actual output against, and the rows the offline
|
||||
//! `ALKANE_FAKE_SCAN` demo mode renders.
|
||||
//! `ALKANE_FAKE_SCAN` demo mode renders. Only miners that respond become rows,
|
||||
//! so there is no synthetic "offline" fixture.
|
||||
//!
|
||||
//! Hashrate/power/temp are representative per-model figures (the bench boards
|
||||
//! are not always energised); the point of the fixtures is a fixed, known input
|
||||
@@ -13,10 +14,16 @@
|
||||
use crate::model::{is_slow, MinerRow};
|
||||
|
||||
/// One fixture board, pre-transform. `expected` of 0.0 means "band unknown".
|
||||
/// `make`/`model_id`/`board` mirror what asic-rs actually reports (compact
|
||||
/// identifiers + a bare control-board name) so the fixtures exercise the real
|
||||
/// crate::naming transform, not pre-cleaned strings.
|
||||
struct Board {
|
||||
ip: &'static str,
|
||||
model: &'static str,
|
||||
make: &'static str,
|
||||
model_id: &'static str,
|
||||
board: &'static str,
|
||||
firmware: &'static str,
|
||||
fw_version: &'static str,
|
||||
hashrate: f64,
|
||||
expected: f64,
|
||||
power: f64,
|
||||
@@ -24,6 +31,10 @@ struct Board {
|
||||
fan: f64,
|
||||
worker: &'static str,
|
||||
mining: bool,
|
||||
/// True for the bench board deliberately rebucketed into the "paused"
|
||||
/// status/KPI bucket (not-mining but operator-paused, distinct from a
|
||||
/// unit that is simply idle/not-hashing).
|
||||
paused: bool,
|
||||
}
|
||||
|
||||
impl Board {
|
||||
@@ -37,28 +48,123 @@ impl Board {
|
||||
} else {
|
||||
(None, None, 0.0)
|
||||
};
|
||||
let fan_rpms = if self.mining {
|
||||
vec![self.fan, self.fan * 0.95, self.fan * 1.02]
|
||||
} else {
|
||||
vec![]
|
||||
};
|
||||
// Three per-hashboard chip temps around the average (so the offline demo
|
||||
// shows the "77 / 64 / 74" per-board Chip-temp cell).
|
||||
let board_temps = if self.mining && self.temp > 0.0 {
|
||||
vec![self.temp + 2.0, self.temp - 3.0, self.temp + 1.0]
|
||||
} else {
|
||||
vec![]
|
||||
};
|
||||
// Per-board hashrate for the R2 Health tooltip demo: split the total three
|
||||
// ways with a little variety (index-aligned with the 3 boards).
|
||||
let board_hashrates = if self.mining && self.hashrate > 0.0 {
|
||||
vec![self.hashrate * 0.34, self.hashrate * 0.35, self.hashrate * 0.31]
|
||||
} else {
|
||||
vec![]
|
||||
};
|
||||
// Per-board configured frequency/voltage for the G7 read-side tooltip demo.
|
||||
let (board_frequencies, board_voltages) = if self.mining {
|
||||
(vec![590.0, 590.0, 565.0], vec![13.50, 13.50, 13.35])
|
||||
} else {
|
||||
(vec![], vec![])
|
||||
};
|
||||
// Air-cooled WhatsMiners report an ambient reading (asic-rs surfaces it in
|
||||
// its fluid_temperature field); the scan routes it to env_temp for
|
||||
// air-cooled models, so the demo mirrors that (round 11 #17).
|
||||
let env_temp_c = if self.mining && self.make.eq_ignore_ascii_case("whatsminer") {
|
||||
27.0
|
||||
} else {
|
||||
0.0
|
||||
};
|
||||
// Per-hashboard health dots for the Boards column (round 11 #10): mining
|
||||
// units show three green dots, except two demo cases -- the slow S21 Pro
|
||||
// has one faulted (red) board, and one VNish S19 has a board that wasn't
|
||||
// detected (grey) -- so the offline demo exercises all three states.
|
||||
use crate::model::BoardHealth::{Fault, Missing, Ok};
|
||||
let board_status = if self.mining {
|
||||
match self.ip {
|
||||
"10.255.1.149" => vec![Ok, Fault, Ok],
|
||||
"10.255.1.166" => vec![Ok, Ok, Missing],
|
||||
_ => vec![Ok, Ok, Ok],
|
||||
}
|
||||
} else if self.paused {
|
||||
// A paused miner's boards are physically present but idle (asic-rs
|
||||
// reports active=false -> Fault), so the Health column shows them blue
|
||||
// rather than red (round 19 #19); the offline demo mirrors that.
|
||||
vec![Fault, Fault, Fault]
|
||||
} else {
|
||||
vec![]
|
||||
};
|
||||
// Firmware-flash capability is modeled on the real Bitmain/Antminer
|
||||
// upgrade path (S17/S19/S21 family); WhatsMiner boards in this fleet
|
||||
// don't advertise it, so both true and false show up and the
|
||||
// firmware menu item is testable.
|
||||
let firmware_flash = self.make.eq_ignore_ascii_case("antminer")
|
||||
&& (self.model_id == "S17"
|
||||
|| self.model_id.starts_with("S19")
|
||||
|| self.model_id.starts_with("S21"));
|
||||
// Derive the display identity through the same path the live scan uses.
|
||||
let brand = crate::naming::brand(self.make);
|
||||
let model = crate::naming::clean_model(self.make, self.model_id);
|
||||
let submodel = crate::naming::submodel(self.make, self.model_id);
|
||||
let control_board = crate::naming::control_board_code(self.make, self.board, &model);
|
||||
let cpu = crate::naming::control_board_cpu(self.make, self.board, &model);
|
||||
let board_code = crate::naming::control_board_board(self.make, self.board, &model);
|
||||
// Computed before `model` is moved into the struct literal below.
|
||||
let pic_present = crate::scan::infer_pic(&model);
|
||||
MinerRow {
|
||||
ip: self.ip.to_string(),
|
||||
selected: false,
|
||||
model: self.model.to_string(),
|
||||
model,
|
||||
brand,
|
||||
submodel,
|
||||
firmware: self.firmware.to_string(),
|
||||
fw_version: self.fw_version.to_string(),
|
||||
cpu,
|
||||
board_code,
|
||||
hashrate_ths: self.hashrate,
|
||||
// A miner that is mining or paused reported a current hashrate (a paused
|
||||
// one reports 0 -> "0.00T"); the blank stock demo miner reports none, so
|
||||
// it keeps the "-" dash (round 19 follow-up).
|
||||
hashrate_known: self.mining || self.paused,
|
||||
expected_ths: self.expected,
|
||||
board_hashrates,
|
||||
board_voltages,
|
||||
board_frequencies,
|
||||
efficiency,
|
||||
power_w: self.power,
|
||||
chip_temp_c: self.temp,
|
||||
fan_rpm: self.fan,
|
||||
board_temps,
|
||||
env_temp_c,
|
||||
fan_rpms,
|
||||
worker: self.worker.to_string(),
|
||||
is_mining: self.mining,
|
||||
slow,
|
||||
paused: self.paused,
|
||||
// offline defaults to false (online); these bench rows are reachable.
|
||||
mac: format!("AA:BB:CC:00:{:02X}:{last_octet:02X}", last_octet.wrapping_mul(3)),
|
||||
hostname: format!("miner-{last_octet}"),
|
||||
hashboards: boards,
|
||||
expected_hashboards: Some(3),
|
||||
board_status,
|
||||
total_chips: chips,
|
||||
psu_fan_rpm: if self.mining { self.fan * 0.9 } else { 0.0 },
|
||||
// PSU info demo (round 17 R5): mining units show a version + rated
|
||||
// envelope + live output, so the columns and the R2 PSU tooltip render.
|
||||
psu_version: if self.mining { "22 (117)".to_string() } else { String::new() },
|
||||
psu_voltage_min_v: self.mining.then_some(11.88),
|
||||
psu_voltage_max_v: self.mining.then_some(15.18),
|
||||
psu_out_voltage_v: self.mining.then_some(13.2),
|
||||
psu_out_current_a: self.mining.then_some(210.0),
|
||||
uptime_secs: if self.mining { 3600 * 24 * 2 + 3600 * 5 } else { 0 },
|
||||
light_flashing: Some(false),
|
||||
// One unit is "being located" so the Light column's yellow dot is
|
||||
// demonstrable offline (round 11 #10).
|
||||
light_flashing: Some(self.ip == "10.255.1.167"),
|
||||
pool_url: if self.worker.is_empty() { String::new() } else { "stratum+tcp://pool.blueflare:3333".to_string() },
|
||||
pools: if self.worker.is_empty() {
|
||||
Vec::new()
|
||||
@@ -68,47 +174,108 @@ impl Board {
|
||||
("stratum+tcp://backup.blueflare:3333".to_string(), format!("{}_bak", self.worker)),
|
||||
]
|
||||
},
|
||||
operating_state: if self.mining { "mining".to_string() } else { "idle".to_string() },
|
||||
operating_state: if self.paused {
|
||||
"paused".to_string()
|
||||
} else if self.mining {
|
||||
"mining".to_string()
|
||||
} else {
|
||||
"idle".to_string()
|
||||
},
|
||||
// Synthetic capabilities so the right-click config menu is
|
||||
// exercisable offline: mining units support everything, idle ones
|
||||
// only the fault light + restart (to show the capability intersection).
|
||||
caps: crate::model::MinerCaps {
|
||||
fault_light: true,
|
||||
restart: true,
|
||||
pause: self.mining,
|
||||
resume: self.mining,
|
||||
power_limit: self.mining,
|
||||
tuning: self.mining,
|
||||
hashrate_target: self.mining,
|
||||
supports_presets: self.mining,
|
||||
firmware_flash,
|
||||
pools: true,
|
||||
timezone: self.mining,
|
||||
change_password: true,
|
||||
factory_reset: true,
|
||||
},
|
||||
// Demo values for the round-8/9 columns (synthetic, so the columns
|
||||
// show variety offline). control_board is derived above via naming.
|
||||
algorithm: "SHA256".to_string(),
|
||||
control_board,
|
||||
// Use the same PIC inference the live scan uses (round 18 #12: the demo
|
||||
// previously reimplemented a simplified version that disagreed with it).
|
||||
pic_present,
|
||||
// Access: idle/view-only units (no worker) shown locked; the rest
|
||||
// unlocked. (Live rows infer this from control capabilities.)
|
||||
write_locked: Some(self.worker.is_empty()),
|
||||
// Concise, prefix-free lines (matching summarize_messages output):
|
||||
// the Errors column shows the count, these are the hover tooltip.
|
||||
errors: if self.model_id == "S21Pro" {
|
||||
vec![
|
||||
"hashrate 70% below expected".to_string(),
|
||||
"chip temperature high (HashBoard 2)".to_string(),
|
||||
]
|
||||
} else {
|
||||
Vec::new()
|
||||
},
|
||||
// Demo firmware presets (round 18 / G3) so the "Set profile..." dialog
|
||||
// is exercisable offline on units that advertise preset support.
|
||||
presets: if self.mining {
|
||||
vec![
|
||||
crate::model::MinerPreset { name: "default".into(), pretty: Some("2794 W ~ 121.8 TH @ 590 MHz".into()) },
|
||||
crate::model::MinerPreset { name: "540MHz".into(), pretty: Some("2485 W ~ 111.5 TH @ 540 MHz".into()) },
|
||||
crate::model::MinerPreset { name: "490MHz".into(), pretty: Some("2192 W ~ 101.1 TH @ 490 MHz".into()) },
|
||||
]
|
||||
} else {
|
||||
Vec::new()
|
||||
},
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The 9 bench boards. Two are idle (S17 stock, WardenOS dev), one is slow
|
||||
/// (S21 Pro aml stock at ~30% of expected); the other six hash normally.
|
||||
/// The 9 bench boards (9 rows total). One is idle/not-hashing (S17 stock,
|
||||
/// .112); one is paused (WardenOS dev, .115 - deliberately rebucketed from idle
|
||||
/// so the "paused" status/KPI bucket is exercisable offline); one is slow (S21
|
||||
/// Pro aml stock at ~30% of expected); the other six hash normally.
|
||||
///
|
||||
/// Derived totals (used by the workflow tests):
|
||||
/// total = 9, hashing = 6, slow = 1, not hashing = 2,
|
||||
/// total = 9, hashing = 6, slow = 1, not hashing = 1, paused = 1,
|
||||
/// total hashrate = 685.0 TH/s, total power = 21300 W.
|
||||
pub fn bench_fleet() -> Vec<MinerRow> {
|
||||
let boards = [
|
||||
Board { ip: "10.255.1.112", model: "Antminer S17", firmware: "Stock",
|
||||
// firmware families span the palette (Stock/VNish/Braiins/LuxOS/ePIC/
|
||||
// Hive/BixBit/Alkane) so the offline demo shows the Firmware colouring.
|
||||
Board { ip: "10.255.1.112", make: "Antminer", model_id: "S17", board: "Xilinx", firmware: "Stock", fw_version: "",
|
||||
hashrate: 0.0, expected: 0.0, power: 0.0, temp: 0.0, fan: 0.0,
|
||||
worker: "", mining: false },
|
||||
Board { ip: "10.255.1.166", model: "Antminer S19", firmware: "[removed] 1.2",
|
||||
worker: "", mining: false, paused: false },
|
||||
Board { ip: "10.255.1.166", make: "Antminer", model_id: "S19", board: "BeagleBoneBlack", firmware: "VNish", fw_version: "1.2.8",
|
||||
hashrate: 95.0, expected: 96.0, power: 3250.0, temp: 65.0, fan: 4200.0,
|
||||
worker: "blueflare.s19", mining: true },
|
||||
Board { ip: "10.255.1.152", model: "Antminer S19j Pro", firmware: "[removed] 1.2",
|
||||
worker: "blueflare.s19", mining: true, paused: false },
|
||||
Board { ip: "10.255.1.152", make: "Antminer", model_id: "S19jPro", board: "AMLogic", firmware: "Braiins", fw_version: "25.05.1",
|
||||
hashrate: 100.0, expected: 104.0, power: 3100.0, temp: 62.0, fan: 3900.0,
|
||||
worker: "blueflare.s19jpro", mining: true },
|
||||
Board { ip: "10.255.1.167", model: "Antminer S19k Pro", firmware: "[removed] 1.2",
|
||||
worker: "blueflare.s19jpro", mining: true, paused: false },
|
||||
Board { ip: "10.255.1.167", make: "Antminer", model_id: "S19KPro", board: "AMLogic", firmware: "LuxOS", fw_version: "2024.9.0",
|
||||
hashrate: 120.0, expected: 128.0, power: 3300.0, temp: 68.0, fan: 4500.0,
|
||||
worker: "blueflare.s19kpro", mining: true },
|
||||
Board { ip: "10.255.1.149", model: "Antminer S21 Pro", firmware: "Stock",
|
||||
worker: "blueflare.s19kpro", mining: true, paused: false },
|
||||
Board { ip: "10.255.1.149", make: "Antminer", model_id: "S21Pro", board: "CVITek", firmware: "ePIC", fw_version: "1.0.3",
|
||||
hashrate: 60.0, expected: 200.0, power: 1500.0, temp: 55.0, fan: 3000.0,
|
||||
worker: "blueflare.s21pro", mining: true }, // slow: 60/200 = 30%
|
||||
Board { ip: "10.255.1.126", model: "WhatsMiner M30S", firmware: "WMOS H3",
|
||||
worker: "blueflare.s21pro", mining: true, paused: false }, // slow: 60/200 = 30%
|
||||
Board { ip: "10.255.1.126", make: "Whatsminer", model_id: "M30SVE40", board: "H3", firmware: "Stock", fw_version: "H3.0.1",
|
||||
hashrate: 92.0, expected: 96.0, power: 3400.0, temp: 70.0, fan: 4800.0,
|
||||
worker: "blueflare.h3", mining: true },
|
||||
Board { ip: "10.255.1.131", model: "WhatsMiner M30S+", firmware: "WMOS H616",
|
||||
worker: "blueflare.h3", mining: true, paused: false },
|
||||
Board { ip: "10.255.1.131", make: "Whatsminer", model_id: "M30SPlusVE40", board: "H616", firmware: "Hiveon", fw_version: "1.05",
|
||||
hashrate: 100.0, expected: 100.0, power: 3450.0, temp: 71.0, fan: 4900.0,
|
||||
worker: "blueflare.h616", mining: true },
|
||||
Board { ip: "10.255.1.148", model: "WhatsMiner M50", firmware: "WMOS CB4",
|
||||
worker: "blueflare.h616", mining: true, paused: false },
|
||||
Board { ip: "10.255.1.148", make: "Whatsminer", model_id: "M50VH50", board: "H6", firmware: "Bixbit", fw_version: "0.9.9.4",
|
||||
hashrate: 118.0, expected: 122.0, power: 3300.0, temp: 66.0, fan: 4600.0,
|
||||
worker: "blueflare.m50", mining: true },
|
||||
Board { ip: "10.255.1.115", model: "Antminer S19", firmware: "WardenOS dev",
|
||||
worker: "blueflare.m50", mining: true, paused: false },
|
||||
// Rebucketed from idle/not-hashing to paused so the "paused"
|
||||
// status/KPI bucket is exercisable in the fake-scan/offline demo.
|
||||
Board { ip: "10.255.1.115", make: "Antminer", model_id: "S19", board: "BeagleBoneBlack", firmware: "Alkane", fw_version: "0.1",
|
||||
hashrate: 0.0, expected: 0.0, power: 0.0, temp: 0.0, fan: 0.0,
|
||||
worker: "", mining: false },
|
||||
worker: "", mining: false, paused: true },
|
||||
];
|
||||
boards.into_iter().map(Board::into_row).collect()
|
||||
}
|
||||
|
||||
@@ -0,0 +1,162 @@
|
||||
//! Lightweight UI localization (round 15 #13).
|
||||
//!
|
||||
//! Visible strings are wrapped in `t("English text")`; the English text is the
|
||||
//! lookup key. `t` returns the translation for the current language, falling back
|
||||
//! to the English key when a string has no translation yet. The language is a
|
||||
//! process-global, persisted under the config dir; changing it re-titles the
|
||||
//! table columns and toolbar/KPI labels live and localizes dialogs as they open.
|
||||
|
||||
use std::path::PathBuf;
|
||||
use std::sync::atomic::{AtomicU8, Ordering};
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum Lang {
|
||||
En,
|
||||
Zh,
|
||||
Ru,
|
||||
Fr,
|
||||
Es,
|
||||
Pt,
|
||||
}
|
||||
|
||||
impl Lang {
|
||||
pub fn all() -> [Lang; 6] {
|
||||
[Lang::En, Lang::Zh, Lang::Ru, Lang::Fr, Lang::Es, Lang::Pt]
|
||||
}
|
||||
/// The language's own name, for the selector menu.
|
||||
pub fn label(self) -> &'static str {
|
||||
match self {
|
||||
Lang::En => "English",
|
||||
Lang::Zh => "\u{4e2d}\u{6587}", // 中文
|
||||
Lang::Ru => "\u{0420}\u{0443}\u{0441}\u{0441}\u{043a}\u{0438}\u{0439}", // Русский
|
||||
Lang::Fr => "Fran\u{e7}ais",
|
||||
Lang::Es => "Espa\u{f1}ol",
|
||||
Lang::Pt => "Portugu\u{ea}s",
|
||||
}
|
||||
}
|
||||
fn code(self) -> &'static str {
|
||||
match self {
|
||||
Lang::En => "en",
|
||||
Lang::Zh => "zh",
|
||||
Lang::Ru => "ru",
|
||||
Lang::Fr => "fr",
|
||||
Lang::Es => "es",
|
||||
Lang::Pt => "pt",
|
||||
}
|
||||
}
|
||||
fn from_code(s: &str) -> Lang {
|
||||
match s.trim() {
|
||||
"zh" => Lang::Zh,
|
||||
"ru" => Lang::Ru,
|
||||
"fr" => Lang::Fr,
|
||||
"es" => Lang::Es,
|
||||
"pt" => Lang::Pt,
|
||||
_ => Lang::En,
|
||||
}
|
||||
}
|
||||
fn index(self) -> usize {
|
||||
match self {
|
||||
Lang::En => 0,
|
||||
Lang::Zh => 1,
|
||||
Lang::Ru => 2,
|
||||
Lang::Fr => 3,
|
||||
Lang::Es => 4,
|
||||
Lang::Pt => 5,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static CURRENT: AtomicU8 = AtomicU8::new(0);
|
||||
|
||||
const LANG_FILE: &str = "language.txt";
|
||||
|
||||
fn config_path() -> PathBuf {
|
||||
let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
|
||||
PathBuf::from(home).join(".config/alkane-toolkit").join(LANG_FILE)
|
||||
}
|
||||
|
||||
/// Load the saved language into the global (call once at startup).
|
||||
pub fn init() {
|
||||
let l = std::fs::read_to_string(config_path())
|
||||
.ok()
|
||||
.map(|s| Lang::from_code(&s))
|
||||
.unwrap_or(Lang::En);
|
||||
CURRENT.store(lang_to_u8(l), Ordering::Relaxed);
|
||||
}
|
||||
|
||||
pub fn current() -> Lang {
|
||||
u8_to_lang(CURRENT.load(Ordering::Relaxed))
|
||||
}
|
||||
|
||||
/// Set + persist the language.
|
||||
pub fn set(l: Lang) {
|
||||
CURRENT.store(lang_to_u8(l), Ordering::Relaxed);
|
||||
let p = config_path();
|
||||
if let Some(dir) = p.parent() {
|
||||
let _ = std::fs::create_dir_all(dir);
|
||||
}
|
||||
let _ = std::fs::write(p, l.code());
|
||||
}
|
||||
|
||||
fn lang_to_u8(l: Lang) -> u8 {
|
||||
l.index() as u8
|
||||
}
|
||||
fn u8_to_lang(v: u8) -> Lang {
|
||||
Lang::all().get(v as usize).copied().unwrap_or(Lang::En)
|
||||
}
|
||||
|
||||
/// Translate `key` (an English string) to the current language, or return `key`
|
||||
/// when there is no translation.
|
||||
pub fn t(key: &str) -> String {
|
||||
let lang = current();
|
||||
if lang == Lang::En {
|
||||
return key.to_string();
|
||||
}
|
||||
for (en, tr) in TABLE {
|
||||
if *en == key {
|
||||
let s = tr[lang.index()];
|
||||
if !s.is_empty() {
|
||||
return s.to_string();
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
key.to_string()
|
||||
}
|
||||
|
||||
// Translation table: (English, [en, zh, ru, fr, es, pt]). The en slot mirrors the
|
||||
// key (unused by `t`, kept for readability). An empty slot falls back to English.
|
||||
#[rustfmt::skip]
|
||||
const TABLE: &[(&str, [&str; 6])] = &[
|
||||
// Toolbar + settings
|
||||
("Scan ranges", ["Scan ranges", "\u{626b}\u{63cf}\u{8303}\u{56f4}", "\u{0414}\u{0438}\u{0430}\u{043f}\u{0430}\u{0437}\u{043e}\u{043d}\u{044b}", "Plages", "Rangos", "Faixas"]),
|
||||
("Presets", ["Presets", "\u{9884}\u{8bbe}", "\u{041f}\u{0440}\u{0435}\u{0441}\u{0435}\u{0442}\u{044b}", "Pr\u{e9}r\u{e9}glages", "Ajustes", "Predefini\u{e7}\u{f5}es"]),
|
||||
("Filter", ["Filter", "\u{7b5b}\u{9009}", "\u{0424}\u{0438}\u{043b}\u{044c}\u{0442}\u{0440}", "Filtre", "Filtro", "Filtro"]),
|
||||
("Columns", ["Columns", "\u{5217}", "\u{0421}\u{0442}\u{043e}\u{043b}\u{0431}\u{0446}\u{044b}", "Colonnes", "Columnas", "Colunas"]),
|
||||
("Export", ["Export", "\u{5bfc}\u{51fa}", "\u{042d}\u{043a}\u{0441}\u{043f}\u{043e}\u{0440}\u{0442}", "Exporter", "Exportar", "Exportar"]),
|
||||
("Settings", ["Settings", "\u{8bbe}\u{7f6e}", "\u{041d}\u{0430}\u{0441}\u{0442}\u{0440}\u{043e}\u{0439}\u{043a}\u{0438}", "Param\u{e8}tres", "Ajustes", "Configura\u{e7}\u{f5}es"]),
|
||||
("Credentials", ["Credentials", "\u{51ed}\u{636e}", "\u{0423}\u{0447}\u{0451}\u{0442}\u{043d}\u{044b}\u{0435} \u{0434}\u{0430}\u{043d}\u{043d}\u{044b}\u{0435}", "Identifiants", "Credenciales", "Credenciais"]),
|
||||
("Language", ["Language", "\u{8bed}\u{8a00}", "\u{042f}\u{0437}\u{044b}\u{043a}", "Langue", "Idioma", "Idioma"]),
|
||||
("Logs", ["Logs", "\u{65e5}\u{5fd7}", "\u{0416}\u{0443}\u{0440}\u{043d}\u{0430}\u{043b}", "Journaux", "Registros", "Registos"]),
|
||||
// KPI captions
|
||||
("Total", ["Total", "\u{603b}\u{6570}", "\u{0412}\u{0441}\u{0435}\u{0433}\u{043e}", "Total", "Total", "Total"]),
|
||||
("Hashing", ["Hashing", "\u{6b63}\u{5728}\u{6316}\u{77ff}", "\u{0425}\u{0435}\u{0448}\u{0438}\u{0440}\u{043e}\u{0432}\u{0430}\u{043d}\u{0438}\u{0435}", "Minage", "Minando", "Minerando"]),
|
||||
("Slow", ["Slow", "\u{7f13}\u{6162}", "\u{041c}\u{0435}\u{0434}\u{043b}\u{0435}\u{043d}\u{043d}\u{043e}", "Lent", "Lento", "Lento"]),
|
||||
("Not hashing", ["Not hashing", "\u{672a}\u{6316}\u{77ff}", "\u{041d}\u{0435} \u{0445}\u{0435}\u{0448}\u{0438}\u{0440}\u{0443}\u{0435}\u{0442}", "Inactif", "Inactivo", "Inativo"]),
|
||||
("Paused", ["Paused", "\u{5df2}\u{6682}\u{505c}", "\u{041f}\u{0430}\u{0443}\u{0437}\u{0430}", "En pause", "Pausado", "Pausado"]),
|
||||
("Est. power", ["Est. power", "\u{4f30}\u{8ba1}\u{529f}\u{7387}", "\u{041e}\u{0446}. \u{043c}\u{043e}\u{0449}\u{043d}.", "Puiss. est.", "Pot. est.", "Pot. est."]),
|
||||
// Column headers (the default-visible set + common ones)
|
||||
("Model", ["Model", "\u{578b}\u{53f7}", "\u{041c}\u{043e}\u{0434}\u{0435}\u{043b}\u{044c}", "Mod\u{e8}le", "Modelo", "Modelo"]),
|
||||
("Health", ["Health", "\u{72b6}\u{6001}", "\u{0421}\u{043e}\u{0441}\u{0442}\u{043e}\u{044f}\u{043d}\u{0438}\u{0435}", "\u{c9}tat", "Estado", "Sa\u{fa}de"]),
|
||||
("Hashrate", ["Hashrate", "\u{7b97}\u{529b}", "\u{0425}\u{0435}\u{0448}\u{0440}\u{0435}\u{0439}\u{0442}", "Hashrate", "Hashrate", "Hashrate"]),
|
||||
("Power", ["Power", "\u{529f}\u{7387}", "\u{041c}\u{043e}\u{0449}\u{043d}\u{043e}\u{0441}\u{0442}\u{044c}", "Puissance", "Potencia", "Pot\u{ea}ncia"]),
|
||||
("Chip temp", ["Chip temp", "\u{82af}\u{7247}\u{6e29}\u{5ea6}", "\u{0422}\u{0435}\u{043c}\u{043f}. \u{0447}\u{0438}\u{043f}\u{0430}", "Temp. puce", "Temp. chip", "Temp. chip"]),
|
||||
("Firmware", ["Firmware", "\u{56fa}\u{4ef6}", "\u{041f}\u{0440}\u{043e}\u{0448}\u{0438}\u{0432}\u{043a}\u{0430}", "Firmware", "Firmware", "Firmware"]),
|
||||
("CPU", ["CPU", "CPU", "\u{041f}\u{0440}\u{043e}\u{0446}.", "Processeur", "CPU", "CPU"]),
|
||||
("Access", ["Access", "\u{8bbf}\u{95ee}", "\u{0414}\u{043e}\u{0441}\u{0442}\u{0443}\u{043f}", "Acc\u{e8}s", "Acceso", "Acesso"]),
|
||||
("Light", ["Light", "\u{6307}\u{793a}\u{706f}", "\u{041f}\u{043e}\u{0434}\u{0441}\u{0432}\u{0435}\u{0442}\u{043a}\u{0430}", "Voyant", "Luz", "Luz"]),
|
||||
("Fan (RPM)", ["Fan (RPM)", "\u{98ce}\u{6247} (RPM)", "\u{0412}\u{0435}\u{043d}\u{0442}. (\u{043e}\u{0431}/\u{043c}\u{0438}\u{043d})", "Ventilo (TR/M)", "Ventilador (RPM)", "Ventoinha (RPM)"]),
|
||||
("Control Board", ["Control Board", "\u{63a7}\u{5236}\u{677f}", "\u{041f}\u{043b}\u{0430}\u{0442}\u{0430} \u{0443}\u{043f}\u{0440}.", "Carte de contr\u{f4}le", "Placa control", "Placa controlo"]),
|
||||
("Uptime", ["Uptime", "\u{8fd0}\u{884c}\u{65f6}\u{95f4}", "\u{0412}\u{0440}\u{0435}\u{043c}\u{044f} \u{0440}\u{0430}\u{0431}.", "Dur\u{e9}e", "Tiempo activo", "Tempo ativo"]),
|
||||
("Serial", ["Serial", "\u{5e8f}\u{5217}\u{53f7}", "\u{0421}\u{0435}\u{0440}\u{0438}\u{0439}\u{043d}\u{044b}\u{0439}", "N\u{b0} de s\u{e9}rie", "N\u{b0} de serie", "N\u{b0} de s\u{e9}rie"]),
|
||||
];
|
||||
@@ -0,0 +1,83 @@
|
||||
//! Fetch a miner's log for the "View log (API)" viewer (round 12 #12, reworked
|
||||
//! round 19 #11-16).
|
||||
//!
|
||||
//! The log is fetched through asic-rs's per-backend `read_logs()` API, which
|
||||
//! knows each firmware's real transport (Antminer/Z15 + BixBit stock web,
|
||||
//! Braiins gRPC/journal, VNish and ePIC HTTP, ...). This replaced the GUI's
|
||||
//! narrow three-way curl fetch, whose stock `/cgi-bin/log.cgi` `else` branch
|
||||
//! failed on every firmware that does not serve that CGI (Braiins, LuxOS, Z15,
|
||||
//! BixBit).
|
||||
//!
|
||||
//! WhatsMiner is the exception: its btminer log is not exposed over the API, and
|
||||
//! asic-rs has no `read_logs` for it, so the viewer falls back to the active
|
||||
//! fault codes (get_error_code on :4028, unauthenticated). LuxOS likewise has no
|
||||
//! asic-rs log API and reports the log as unavailable.
|
||||
|
||||
/// Cap on the log text we keep for display (bytes); a miner's freshest lines are
|
||||
/// at the tail, so we keep the tail.
|
||||
const MAX_LOG_BYTES: usize = 256 * 1024;
|
||||
|
||||
/// A fetched log for the viewer.
|
||||
pub struct LogScan {
|
||||
/// The (possibly tail-trimmed) log text.
|
||||
pub text: String,
|
||||
}
|
||||
|
||||
/// Fetch one miner's log. `brand` is the make ("Antminer"/"Whatsminer"/...);
|
||||
/// `timeout_secs` is the per-miner identification timeout. Returns `Err` only
|
||||
/// when no log could be read.
|
||||
pub fn scan_log(ip: &str, brand: &str, timeout_secs: u64) -> Result<LogScan, String> {
|
||||
// WhatsMiner's real log is not exposed over its API and asic-rs has no
|
||||
// read_logs for it, so show the active fault codes instead of failing.
|
||||
if brand.eq_ignore_ascii_case("whatsminer") {
|
||||
let resp = crate::access_probe::whatsminer_get_error_code(ip)
|
||||
.ok_or_else(|| "WhatsMiner did not answer get_error_code on :4028".to_string())?;
|
||||
return Ok(LogScan { text: tail(&resp, MAX_LOG_BYTES) });
|
||||
}
|
||||
let text = crate::scan::fetch_log(ip, timeout_secs)?;
|
||||
if text.trim().is_empty() {
|
||||
return Err("the miner returned an empty log".to_string());
|
||||
}
|
||||
Ok(LogScan { text: tail(&text, MAX_LOG_BYTES) })
|
||||
}
|
||||
|
||||
/// Keep the last `max` bytes of `s` (a log's tail is the freshest), on a line
|
||||
/// boundary, with a marker when trimmed.
|
||||
fn tail(s: &str, max: usize) -> String {
|
||||
if s.len() <= max {
|
||||
return s.to_string();
|
||||
}
|
||||
// Nudge the cut forward to a UTF-8 char boundary first: a raw byte offset can
|
||||
// land inside a multi-byte character and slicing there would panic (round 18
|
||||
// #12; miner logs are not guaranteed pure ASCII).
|
||||
let mut start = s.len() - max;
|
||||
while start < s.len() && !s.is_char_boundary(start) {
|
||||
start += 1;
|
||||
}
|
||||
// then advance to the next line boundary so we don't cut a line in half
|
||||
let start = s[start..].find('\n').map(|i| start + i + 1).unwrap_or(start);
|
||||
format!("[... earlier log trimmed ...]\n{}", &s[start..])
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn tail_does_not_panic_mid_multibyte_char() {
|
||||
// A byte-offset cut can land inside a multi-byte character; tail must nudge
|
||||
// to a char boundary rather than panic (round 18 #12).
|
||||
let s = "\u{00e9}".repeat(200); // 400 bytes of 2-byte chars, no newlines
|
||||
let out = tail(&s, 101); // cut at an odd offset -> inside a char
|
||||
assert!(out.starts_with("[... earlier log trimmed ...]"));
|
||||
assert!(out.len() < s.len());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tail_trims_on_line_boundary() {
|
||||
let log = "aaaa\nbbbb\ncccc\n";
|
||||
let t = tail(log, 6);
|
||||
assert!(t.starts_with("[... earlier log trimmed ...]"), "{t}");
|
||||
assert!(t.ends_with("cccc\n"));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
//! In-app activity log (round 15 #13). A small, process-global ring buffer of
|
||||
//! timestamped messages -- scans starting/finishing, operations applied, errors --
|
||||
//! shown in the Settings > Logs page. Thread-safe so background workers can append.
|
||||
|
||||
use std::sync::Mutex;
|
||||
use std::time::{SystemTime, UNIX_EPOCH};
|
||||
|
||||
const MAX_ENTRIES: usize = 2000;
|
||||
|
||||
static LOG: Mutex<Vec<String>> = Mutex::new(Vec::new());
|
||||
|
||||
/// Local wall-clock HH:MM:SS for a log line. Uses the system clock offset from
|
||||
/// UTC via the TZ-less epoch; good enough for an activity log timestamp.
|
||||
fn stamp() -> String {
|
||||
let secs = SystemTime::now().duration_since(UNIX_EPOCH).map(|d| d.as_secs()).unwrap_or(0);
|
||||
let t = secs % 86_400;
|
||||
format!("{:02}:{:02}:{:02}", t / 3600, (t % 3600) / 60, t % 60)
|
||||
}
|
||||
|
||||
/// Append a message to the activity log (timestamped).
|
||||
pub fn log(msg: impl Into<String>) {
|
||||
let line = format!("{} {}", stamp(), msg.into());
|
||||
if let Ok(mut v) = LOG.lock() {
|
||||
v.push(line);
|
||||
let len = v.len();
|
||||
if len > MAX_ENTRIES {
|
||||
v.drain(0..len - MAX_ENTRIES);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The whole log as one string, newest last (for the Logs page text box).
|
||||
pub fn dump() -> String {
|
||||
LOG.lock().map(|v| v.join("\n")).unwrap_or_default()
|
||||
}
|
||||
|
||||
/// Clear the log.
|
||||
pub fn clear() {
|
||||
if let Ok(mut v) = LOG.lock() {
|
||||
v.clear();
|
||||
}
|
||||
}
|
||||
@@ -1,12 +1,21 @@
|
||||
//! alkane-toolkit — primary view (docs/UI-SPEC.md).
|
||||
//! Pure-Rust wxWidgets app on the vendored, patched wx-rs.
|
||||
|
||||
mod access_probe;
|
||||
mod credentials;
|
||||
mod export;
|
||||
mod fixtures;
|
||||
mod i18n;
|
||||
mod logs;
|
||||
mod log_scan;
|
||||
mod model;
|
||||
mod naming;
|
||||
mod pool_prefs;
|
||||
mod presets;
|
||||
mod restore;
|
||||
mod scan;
|
||||
mod ui;
|
||||
|
||||
use wx_rs;
|
||||
|
||||
fn main() {
|
||||
// Headless workflow self-test: render the bench-fleet fixtures through the
|
||||
@@ -16,6 +25,42 @@ fn main() {
|
||||
std::process::exit(run_selftest());
|
||||
}
|
||||
|
||||
// Headless access-probe check: `ALKANE_ACCESS_PROBE="<ip> <make>"` prints the
|
||||
// lock state the real access probe computes (no GUI, no wx), so the WhatsMiner
|
||||
// :4028 token check and the Antminer digest check can be verified directly.
|
||||
if let Some(spec) = std::env::var_os("ALKANE_ACCESS_PROBE") {
|
||||
let spec = spec.to_string_lossy();
|
||||
let mut it = spec.split_whitespace();
|
||||
let ip = it.next().unwrap_or("");
|
||||
let make = it.next().unwrap_or("");
|
||||
let (user, pass) = credentials::load_credentials().unwrap_or_default();
|
||||
match access_probe::probe_access(ip, make, &user, &pass) {
|
||||
Ok(Some(true)) => println!("ACCESS {ip} {make}: LOCKED"),
|
||||
Ok(Some(false)) => println!("ACCESS {ip} {make}: UNLOCKED"),
|
||||
Ok(None) => println!("ACCESS {ip} {make}: INDETERMINATE"),
|
||||
Err(e) => println!("ACCESS {ip} {make}: ERROR {e}"),
|
||||
}
|
||||
std::process::exit(0);
|
||||
}
|
||||
|
||||
// Headless log-scan check: `ALKANE_LOG_SCAN="<ip> <brand>"` fetches the miner's
|
||||
// log through asic-rs's per-backend read_logs() (round 19 #11-16), so the log
|
||||
// paths can be verified without the GUI. WhatsMiner falls back to fault codes.
|
||||
if let Some(spec) = std::env::var_os("ALKANE_LOG_SCAN") {
|
||||
let spec = spec.to_string_lossy();
|
||||
let mut it = spec.split_whitespace();
|
||||
let ip = it.next().unwrap_or("");
|
||||
let brand = it.next().unwrap_or("");
|
||||
match log_scan::scan_log(ip, brand, scan::load_scan_timeout()) {
|
||||
Ok(s) => println!("LOGSCAN {ip} ({brand}): {} log bytes", s.text.len()),
|
||||
Err(e) => println!("LOGSCAN {ip} ({brand}): ERROR {e}"),
|
||||
}
|
||||
std::process::exit(0);
|
||||
}
|
||||
|
||||
// Load the saved UI language before any strings are built (round 15 #13).
|
||||
i18n::init();
|
||||
|
||||
// Bootstrap the wx app + main frame (upstream bridge).
|
||||
wx_rs::init_app("alkane-toolkit", 1280, 800);
|
||||
// Follow the system light/dark appearance.
|
||||
|
||||
@@ -0,0 +1,523 @@
|
||||
//! Display-layer device-naming cleanup (round-9 item #11).
|
||||
//!
|
||||
//! asic-rs hands us compact Rust-identifier model strings and bare control-board
|
||||
//! names, not human-facing labels:
|
||||
//! - `device_info.make` = "Antminer" / "Whatsminer" (note the casing)
|
||||
//! - `device_info.model` = the model enum's variant identifier verbatim, e.g.
|
||||
//! "S19KPro", "S19jPro", "M30SPlusVE40", "M30SPlusPlusVE40" -- no spaces,
|
||||
//! "+" rendered "Plus", "++" rendered "PlusPlus", the WhatsMiner version
|
||||
//! block ("VE40") baked in.
|
||||
//! - `control_board_version` = a bare board name ("Xilinx", "CVITek",
|
||||
//! "AMLogic", "BeagleBoneBlack"; WhatsMiner "H3"/"H6"/"H6OS"/"H616").
|
||||
//!
|
||||
//! This module turns those into the Brand / Model / Submodel / control-board
|
||||
//! short code the table shows. It is a pure string transform -- no asic-rs edit
|
||||
//! -- so it stays a build-on-top layer over the vendored crate.
|
||||
//!
|
||||
//! Known limitations (asic-rs does not expose the data):
|
||||
//! - Antminer has no hashboard-type/submodel over the network, so Submodel is
|
||||
//! blank for Antminer (only WhatsMiner's version block is recoverable).
|
||||
//! - asic-rs reports only "AMLogic" (not the 120mm C76 vs 140mm CBE board) and
|
||||
//! only "Xilinx" (not C49 vs C55); we disambiguate by model family as a
|
||||
//! best-effort heuristic documented at `control_board_code`.
|
||||
|
||||
/// Human brand from asic-rs `device_info.make`.
|
||||
pub fn brand(make: &str) -> String {
|
||||
match make.trim().to_ascii_lowercase().as_str() {
|
||||
"antminer" => "Antminer".to_string(),
|
||||
"whatsminer" => "WhatsMiner".to_string(),
|
||||
"" => String::new(),
|
||||
other => {
|
||||
// Title-case an unknown make so the Brand column still reads well.
|
||||
let mut c = other.chars();
|
||||
match c.next() {
|
||||
Some(f) => f.to_ascii_uppercase().to_string() + c.as_str(),
|
||||
None => String::new(),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn is_whatsminer(make: &str) -> bool {
|
||||
make.trim().eq_ignore_ascii_case("whatsminer")
|
||||
}
|
||||
|
||||
fn is_antminer(make: &str) -> bool {
|
||||
make.trim().eq_ignore_ascii_case("antminer")
|
||||
}
|
||||
|
||||
/// Split asic-rs's firmware family string into the family shown in the Firmware
|
||||
/// column and an optional vendor prefix that moves into the FW Version column
|
||||
/// (round 11 #6). asic-rs reports stock firmware as "AntMiner Stock" /
|
||||
/// "WhatsMiner Stock"; the Firmware column should read just "Stock" (so it
|
||||
/// colours as the neutral/default family), and the vendor word belongs with the
|
||||
/// version. Aftermarket families ("VNish", "Braiins", ...) carry no vendor
|
||||
/// prefix and pass through unchanged.
|
||||
pub fn firmware_family(raw: &str) -> (String, Option<String>) {
|
||||
let trimmed = raw.trim();
|
||||
// Vendor prefixes asic-rs prepends on stock-firmware family strings, matched
|
||||
// case-insensitively.
|
||||
for vendor in ["AntMiner", "WhatsMiner"] {
|
||||
if trimmed.len() > vendor.len()
|
||||
&& trimmed
|
||||
.get(..vendor.len())
|
||||
.is_some_and(|prefix| prefix.eq_ignore_ascii_case(vendor))
|
||||
{
|
||||
let rest = trimmed[vendor.len()..].trim();
|
||||
if !rest.is_empty() {
|
||||
return (rest.to_string(), Some(vendor.to_string()));
|
||||
}
|
||||
}
|
||||
}
|
||||
(trimmed.to_string(), None)
|
||||
}
|
||||
|
||||
/// Whether a miner is liquid-cooled (hydro / water / immersion) rather than
|
||||
/// air-cooled, inferred from the model name (round 11 #17). asic-rs exposes no
|
||||
/// cooling-type field, so this is a best-effort model-string heuristic: it
|
||||
/// decides whether a reported "fluid" temperature is a real coolant reading or
|
||||
/// (for air-cooled units) the ambient/environment temperature.
|
||||
pub fn is_liquid_cooled(model: &str) -> bool {
|
||||
let m = model.to_ascii_lowercase();
|
||||
m.contains("hydro") || m.contains("immers") || m.contains("water")
|
||||
}
|
||||
|
||||
/// The human model name for the Model column: brand dropped (it has its own
|
||||
/// column), family-letter suffix lowercased, word suffixes spaced, "+"/"++" for
|
||||
/// Plus/PlusPlus, and (WhatsMiner) the trailing version block moved to Submodel.
|
||||
pub fn clean_model(make: &str, model_id: &str) -> String {
|
||||
let id = model_id.trim();
|
||||
if id.is_empty() {
|
||||
return String::new();
|
||||
}
|
||||
if is_whatsminer(make) {
|
||||
clean_whatsminer(id).0
|
||||
} else if is_antminer(make) {
|
||||
clean_antminer(id)
|
||||
} else {
|
||||
id.to_string()
|
||||
}
|
||||
}
|
||||
|
||||
/// Best-effort ASIC chip model for a miner, used ONLY as a fallback when the
|
||||
/// firmware did not report a chip type on the wire (round 21 #3). Most firmwares
|
||||
/// on Antminer hardware (stock Antminer, VNish, LuxOS, Braiins, UMC) never put the
|
||||
/// chip string in their API, but the chip is a fixed per-model hardware fact, so
|
||||
/// it can be derived from the detected model. Only high-confidence, widely
|
||||
/// documented Antminer mappings are returned; everything else (and WhatsMiner,
|
||||
/// whose chips are not cleanly named) returns None so the column stays blank
|
||||
/// rather than show a guess. `model_id` is the raw asic-rs model id.
|
||||
pub fn chip_type_for_model(make: &str, model_id: &str) -> Option<&'static str> {
|
||||
if !is_antminer(make) {
|
||||
return None;
|
||||
}
|
||||
// Normalize: drop a leading "ANTMINER ", cut any trailing parenthetical
|
||||
// ("S19 (88)" -> "S19"), uppercase, and strip every non-alphanumeric char.
|
||||
let base = model_id.trim();
|
||||
let base = base
|
||||
.strip_prefix("ANTMINER ")
|
||||
.or_else(|| base.strip_prefix("Antminer "))
|
||||
.unwrap_or(base);
|
||||
let base = base.split('(').next().unwrap_or(base);
|
||||
let key: String = base
|
||||
.chars()
|
||||
.filter(|c| c.is_ascii_alphanumeric())
|
||||
.map(|c| c.to_ascii_uppercase())
|
||||
.collect();
|
||||
// Bitmain chip per model (SHA-256 air/hydro). Sources: Bitmain shop specs +
|
||||
// repair-guide chip markings. Keep conservative -- omit uncertain variants.
|
||||
let chip = match key.as_str() {
|
||||
"S19" | "S19PRO" | "S19A" | "S19APRO" | "T19" => "BM1398",
|
||||
"S19PROPLUSHYD" | "S19PROPLUSHYDRO" | "S19PROHYD" | "S19PROHYDRO" => "BM1398",
|
||||
"S19J" | "S19JPRO" | "S19JPROPLUS" | "S19JPRONOPIC" => "BM1362",
|
||||
"S19XP" | "S19XPHYD" | "S19XPHYDRO" | "S19KPRO" | "S19KPRONOPIC" => "BM1366",
|
||||
"S21" | "S21PRO" | "S21PLUS" | "S21HYD" | "S21HYDRO" | "T21" => "BM1370",
|
||||
_ => return None,
|
||||
};
|
||||
Some(chip)
|
||||
}
|
||||
|
||||
/// The Submodel column value. WhatsMiner: the version block ("VE40"). Antminer:
|
||||
/// empty -- the hashboard type is not reported over the network by asic-rs.
|
||||
pub fn submodel(make: &str, model_id: &str) -> String {
|
||||
if is_whatsminer(make) {
|
||||
clean_whatsminer(model_id.trim()).1
|
||||
} else {
|
||||
String::new()
|
||||
}
|
||||
}
|
||||
|
||||
/// Split a WhatsMiner identifier into (clean model, version submodel). The
|
||||
/// version block is the trailing run beginning at the first 'V' (WhatsMiner
|
||||
/// tiers never contain a 'V', so the first 'V' always starts the version). The
|
||||
/// prefix's Plus/PlusPlus become +/++.
|
||||
fn clean_whatsminer(id: &str) -> (String, String) {
|
||||
let (prefix, version) = match id.find('V') {
|
||||
Some(i) => (&id[..i], id[i..].to_string()),
|
||||
None => (id, String::new()),
|
||||
};
|
||||
let model = prefix.replace("PlusPlus", "++").replace("Plus", "+");
|
||||
(model, version)
|
||||
}
|
||||
|
||||
/// Known Antminer word-suffixes, longest-first so "PlusPlus" wins over "Plus"
|
||||
/// and "NoPIC" is matched whole. Each maps to its spaced display form.
|
||||
const ANT_SUFFIXES: &[(&str, &str)] = &[
|
||||
("PlusPlus", "++"),
|
||||
("Plus", "+"),
|
||||
("NoPIC", " NoPIC"),
|
||||
("Hydro", " Hydro"),
|
||||
("Pro", " Pro"),
|
||||
("XP", " XP"),
|
||||
];
|
||||
|
||||
/// Clean an Antminer identifier, e.g. "S19KPro" -> "S19k Pro", "S21eXPHydro" ->
|
||||
/// "S21e XP Hydro", "L3PlusPlus" -> "L3++". Unknown/odd inputs pass through.
|
||||
fn clean_antminer(id: &str) -> String {
|
||||
// asic-rs "Unknown" models pass the raw vendor string through with the brand
|
||||
// still in it (e.g. "ANTMINER S19 (88)", a NoPIC S19); drop a redundant
|
||||
// leading brand word so the Model column never repeats the Brand column.
|
||||
// `get(..9)` returns None (rather than panicking) when byte 9 is not a UTF-8
|
||||
// char boundary, so a multibyte miner-supplied model string can't crash here
|
||||
// (round 18 #12). The prefix is 9 ASCII bytes, so a real match implies a
|
||||
// boundary at 9 and the following `id[9..]` is safe.
|
||||
let id = match id.get(..9) {
|
||||
Some(p) if p.eq_ignore_ascii_case("ANTMINER ") => id[9..].trim_start(),
|
||||
_ => id,
|
||||
};
|
||||
let bytes = id.as_bytes();
|
||||
// Base = leading letters then digits ("S19", "KS5", "L3", "Z15"). Without a
|
||||
// letter+digit base (e.g. an Unknown passthrough), return the id unchanged.
|
||||
let mut i = 0;
|
||||
while i < bytes.len() && bytes[i].is_ascii_alphabetic() {
|
||||
i += 1;
|
||||
}
|
||||
let letters_end = i;
|
||||
while i < bytes.len() && bytes[i].is_ascii_digit() {
|
||||
i += 1;
|
||||
}
|
||||
if letters_end == 0 || i == letters_end {
|
||||
return id.to_string();
|
||||
}
|
||||
let mut out = String::from(&id[..i]);
|
||||
let mut rest = &id[i..];
|
||||
|
||||
// An optional single family letter directly after the digits (j/i/a/e/K/L),
|
||||
// recognised as "not the start of a known suffix". Lowercase it, keep it
|
||||
// attached to the base (no space): "S19K" -> "S19k".
|
||||
if let Some(first) = rest.chars().next() {
|
||||
let starts_suffix = ANT_SUFFIXES.iter().any(|(s, _)| rest.starts_with(s));
|
||||
if first.is_ascii_alphabetic() && !starts_suffix {
|
||||
out.push(first.to_ascii_lowercase());
|
||||
rest = &rest[first.len_utf8()..];
|
||||
}
|
||||
}
|
||||
|
||||
// Remaining suffix words, matched greedily against the known set.
|
||||
while !rest.is_empty() {
|
||||
match ANT_SUFFIXES.iter().find(|(s, _)| rest.starts_with(s)) {
|
||||
Some((s, disp)) => {
|
||||
out.push_str(disp);
|
||||
rest = &rest[s.len()..];
|
||||
}
|
||||
None => {
|
||||
// Unknown trailing token: emit it space-separated and stop.
|
||||
out.push(' ');
|
||||
out.push_str(rest.trim_start());
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Normalise a raw control-board name for matching: drop spaces/punctuation and
|
||||
/// uppercase, so "BeagleBone Black", "BeagleBoneBlack" and "BBB" all collapse.
|
||||
fn compact_upper(s: &str) -> String {
|
||||
s.chars().filter(|c| c.is_ascii_alphanumeric()).flat_map(|c| c.to_uppercase()).collect()
|
||||
}
|
||||
|
||||
/// The control-board short code for the Control-board column, e.g.
|
||||
/// "BeagleBoneBlack" -> "BBB (C77)", "Xilinx" on an S17 -> "XIL (C49)".
|
||||
///
|
||||
/// asic-rs reports only the board FAMILY ("AMLogic"/"Xilinx"), never the exact
|
||||
/// Bitmain board number, so where a family spans two boards we disambiguate by
|
||||
/// model era/class (best-effort, since the network data can't distinguish them):
|
||||
/// - Xilinx: S17/T17-era -> C49, otherwise (S19-era) -> C55.
|
||||
/// - AMLogic: XP-class / S19k (140mm fans) -> CBE, otherwise (120mm) -> C76.
|
||||
///
|
||||
/// `clean_model` is the already-cleaned model name (used for the era/class test).
|
||||
pub fn control_board_code(make: &str, board_name: &str, clean_model: &str) -> String {
|
||||
let (cpu, code) = control_board_split(make, board_name, clean_model);
|
||||
if code.is_empty() {
|
||||
cpu
|
||||
} else {
|
||||
format!("{cpu} ({code})")
|
||||
}
|
||||
}
|
||||
|
||||
/// The control-board CPU family short code alone ("AML", "CVI", "BBB", "XIL",
|
||||
/// WhatsMiner "H3"/"H6"/"H6os"/"H616", or the raw name if unrecognised).
|
||||
pub fn control_board_cpu(make: &str, board_name: &str, clean_model: &str) -> String {
|
||||
control_board_split(make, board_name, clean_model).0
|
||||
}
|
||||
|
||||
/// The Bitmain board code alone ("C77"/"C88"/"C49"/"C55"/"C76"/"CBE";
|
||||
/// WhatsMiner "CB2"/"CB4"/"CB6"), or "" when unknown.
|
||||
pub fn control_board_board(make: &str, board_name: &str, clean_model: &str) -> String {
|
||||
control_board_split(make, board_name, clean_model).1
|
||||
}
|
||||
|
||||
/// Split a raw control-board name into (CPU family short code, Bitmain board
|
||||
/// code). asic-rs reports only the board FAMILY ("AMLogic"/"Xilinx"), never the
|
||||
/// exact board number, so where a family spans two boards we disambiguate by
|
||||
/// model era/class (best-effort):
|
||||
/// - Xilinx: S17/T17-era -> C49, otherwise (S19-era) -> C55.
|
||||
/// - AMLogic: XP-class / S19k / S21 (140mm fans) -> CBE, otherwise 120mm C76.
|
||||
fn control_board_split(make: &str, board_name: &str, clean_model: &str) -> (String, String) {
|
||||
let raw = board_name.trim();
|
||||
if raw.is_empty() {
|
||||
return (String::new(), String::new());
|
||||
}
|
||||
// asic-rs renders an unrecognised board as "Unknown: <raw>"; surface it in
|
||||
// the CPU part with no code.
|
||||
if raw.starts_with("Unknown") {
|
||||
return (raw.to_string(), String::new());
|
||||
}
|
||||
let key = compact_upper(raw);
|
||||
let pair = |cpu: &str, code: &str| (cpu.to_string(), code.to_string());
|
||||
|
||||
if is_whatsminer(make) {
|
||||
return match key.as_str() {
|
||||
"H3" => pair("H3", "CB2"),
|
||||
"H6" => pair("H6", "CB4"),
|
||||
"H6OS" => pair("H6os", "CB4"),
|
||||
"H616" => pair("H616", "CB6"),
|
||||
_ => (raw.to_string(), String::new()),
|
||||
};
|
||||
}
|
||||
|
||||
// Antminer (and any make that reports these families).
|
||||
match key.as_str() {
|
||||
"BEAGLEBONEBLACK" | "BBB" | "BB" | "BEAGLEBONE" => pair("BBB", "C77"),
|
||||
"CVITEK" | "CVI" => pair("CVI", "C88"),
|
||||
"XILINX" | "XIL" => {
|
||||
if is_s17_era(clean_model) {
|
||||
pair("XIL", "C49")
|
||||
} else {
|
||||
pair("XIL", "C55")
|
||||
}
|
||||
}
|
||||
"AMLOGIC" | "AML" => {
|
||||
if is_aml_140mm(clean_model) {
|
||||
pair("AML", "CBE")
|
||||
} else {
|
||||
pair("AML", "C76")
|
||||
}
|
||||
}
|
||||
_ => (raw.to_string(), String::new()),
|
||||
}
|
||||
}
|
||||
|
||||
/// S17/T17-era models use the Xilinx C49 control board.
|
||||
fn is_s17_era(clean_model: &str) -> bool {
|
||||
let m = clean_model.trim_start();
|
||||
m.starts_with("S17") || m.starts_with("T17")
|
||||
}
|
||||
|
||||
/// Best-effort: the 140mm-fan AMLogic board (CBE) is used on the XP-class, the
|
||||
/// S19k Pro, and the S21 Pro; everything else AMLogic is the 120mm C76. asic-rs
|
||||
/// cannot tell these apart, so this is a model-family heuristic, not a read.
|
||||
fn is_aml_140mm(clean_model: &str) -> bool {
|
||||
// Per the doc above: XP-class, the S19k Pro, and the S21 Pro -- NOT every S21
|
||||
// (plain S21 / S21+ / S21e are the 120mm C76 board) (round 18 #12).
|
||||
let m = clean_model.trim_start();
|
||||
m.contains("XP") || m.starts_with("S19k") || m.contains("S21 Pro")
|
||||
}
|
||||
|
||||
/// Nameplate expected hashrate in Sol/s for an Equihash (Zcash) miner model, when
|
||||
/// the firmware itself does not report an expected hashrate (round 18 #6). Plain
|
||||
/// Antminer Z15 firmware omits the cgminer `total_rateideal` field (the Z15j does
|
||||
/// report it), so its actual-vs-expected column and colour would otherwise be
|
||||
/// blank. The Z15 nameplate is 420 KSol/s. Returns `None` for models with no known
|
||||
/// nameplate (the caller then leaves expected unknown).
|
||||
pub fn equihash_expected_sols(clean_model: &str) -> Option<f64> {
|
||||
let m = clean_model.to_ascii_lowercase();
|
||||
// Match the Z15 family (z15, z15j); both share the 420 KSol/s nameplate.
|
||||
if m.contains("z15") {
|
||||
Some(420_000.0)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn chip_type_derivation() {
|
||||
// Fleet models (round 21 #3): derived from the detected model for Antminer
|
||||
// hardware where the firmware does not report a chip string on the wire.
|
||||
assert_eq!(chip_type_for_model("Antminer", "S21Pro"), Some("BM1370"));
|
||||
assert_eq!(chip_type_for_model("Antminer", "S19jPro"), Some("BM1362"));
|
||||
assert_eq!(chip_type_for_model("Antminer", "S19KPro"), Some("BM1366"));
|
||||
assert_eq!(chip_type_for_model("Antminer", "S19"), Some("BM1398"));
|
||||
assert_eq!(chip_type_for_model("Antminer", "T19"), Some("BM1398"));
|
||||
// Raw "Unknown" passthrough with brand + parenthetical normalizes to S19.
|
||||
assert_eq!(chip_type_for_model("Antminer", "ANTMINER S19 (88)"), Some("BM1398"));
|
||||
// WhatsMiner chips are not cleanly named -> never derived.
|
||||
assert_eq!(chip_type_for_model("Whatsminer", "M30S+VE40"), None);
|
||||
// Unknown Antminer model -> None (no guess).
|
||||
assert_eq!(chip_type_for_model("Antminer", "L7"), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn brand_normalises_case() {
|
||||
assert_eq!(brand("Antminer"), "Antminer");
|
||||
assert_eq!(brand("Whatsminer"), "WhatsMiner");
|
||||
assert_eq!(brand("whatsminer"), "WhatsMiner");
|
||||
assert_eq!(brand(""), "");
|
||||
assert_eq!(brand("avalonminer"), "Avalonminer");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn antminer_model_cleanup() {
|
||||
// The headline example from the spec.
|
||||
assert_eq!(clean_model("Antminer", "S19KPro"), "S19k Pro");
|
||||
assert_eq!(clean_model("Antminer", "S19jPro"), "S19j Pro");
|
||||
assert_eq!(clean_model("Antminer", "S21Pro"), "S21 Pro");
|
||||
assert_eq!(clean_model("Antminer", "S19"), "S19");
|
||||
assert_eq!(clean_model("Antminer", "S19XP"), "S19 XP");
|
||||
assert_eq!(clean_model("Antminer", "S19jXP"), "S19j XP");
|
||||
assert_eq!(clean_model("Antminer", "S19Plus"), "S19+");
|
||||
assert_eq!(clean_model("Antminer", "S19ProPlus"), "S19 Pro+");
|
||||
assert_eq!(clean_model("Antminer", "S19jProPlus"), "S19j Pro+");
|
||||
assert_eq!(clean_model("Antminer", "S19ProPlusHydro"), "S19 Pro+ Hydro");
|
||||
assert_eq!(clean_model("Antminer", "S19jNoPIC"), "S19j NoPIC");
|
||||
assert_eq!(clean_model("Antminer", "S21PlusPlus"), "S21++");
|
||||
assert_eq!(clean_model("Antminer", "S21eXPHydro"), "S21e XP Hydro");
|
||||
assert_eq!(clean_model("Antminer", "L3PlusPlus"), "L3++");
|
||||
assert_eq!(clean_model("Antminer", "KS5Pro"), "KS5 Pro");
|
||||
assert_eq!(clean_model("Antminer", "Z15Pro"), "Z15 Pro");
|
||||
assert_eq!(clean_model("Antminer", "S9i"), "S9i");
|
||||
assert_eq!(clean_model("Antminer", "S17e"), "S17e");
|
||||
assert_eq!(clean_model("Antminer", "S19a"), "S19a");
|
||||
assert_eq!(clean_model("Antminer", "S19aPro"), "S19a Pro");
|
||||
// asic-rs Unknown passthrough carrying the raw vendor string (a NoPIC
|
||||
// S19 seen live at 10.4.x): drop the redundant brand, keep the rest.
|
||||
assert_eq!(clean_model("Antminer", "ANTMINER S19 (88)"), "S19 (88)");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn whatsminer_model_and_submodel() {
|
||||
assert_eq!(clean_model("Whatsminer", "M30SPlusVE40"), "M30S+");
|
||||
assert_eq!(submodel("Whatsminer", "M30SPlusVE40"), "VE40");
|
||||
assert_eq!(clean_model("Whatsminer", "M30SPlusPlusVE40"), "M30S++");
|
||||
assert_eq!(submodel("Whatsminer", "M30SPlusPlusVE40"), "VE40");
|
||||
assert_eq!(clean_model("Whatsminer", "M30SVE40"), "M30S");
|
||||
assert_eq!(submodel("Whatsminer", "M30SVE40"), "VE40");
|
||||
assert_eq!(clean_model("Whatsminer", "M20S"), "M20S");
|
||||
assert_eq!(submodel("Whatsminer", "M20S"), "");
|
||||
assert_eq!(clean_model("Whatsminer", "M50S++VK30"), "M50S++");
|
||||
assert_eq!(submodel("Whatsminer", "M50S++VK30"), "VK30");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn antminer_has_no_submodel() {
|
||||
assert_eq!(submodel("Antminer", "S19KPro"), "");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn control_board_short_codes() {
|
||||
// Antminer families (board name as asic-rs renders the enum variant).
|
||||
assert_eq!(control_board_code("Antminer", "BeagleBoneBlack", "S19"), "BBB (C77)");
|
||||
// Also accept the spaced form some layers produce.
|
||||
assert_eq!(control_board_code("Antminer", "BeagleBone Black", "S19"), "BBB (C77)");
|
||||
assert_eq!(control_board_code("Antminer", "CVITek", "S21 Pro"), "CVI (C88)");
|
||||
assert_eq!(control_board_code("Antminer", "Xilinx", "S17 Pro"), "XIL (C49)");
|
||||
assert_eq!(control_board_code("Antminer", "Xilinx", "T17"), "XIL (C49)");
|
||||
assert_eq!(control_board_code("Antminer", "Xilinx", "S19 Pro"), "XIL (C55)");
|
||||
assert_eq!(control_board_code("Antminer", "AMLogic", "S19j Pro"), "AML (C76)");
|
||||
assert_eq!(control_board_code("Antminer", "AMLogic", "S19k Pro"), "AML (CBE)");
|
||||
assert_eq!(control_board_code("Antminer", "AMLogic", "S19 XP"), "AML (CBE)");
|
||||
// WhatsMiner families.
|
||||
assert_eq!(control_board_code("Whatsminer", "H3", "M30S"), "H3 (CB2)");
|
||||
assert_eq!(control_board_code("Whatsminer", "H6", "M50"), "H6 (CB4)");
|
||||
assert_eq!(control_board_code("Whatsminer", "H6OS", "M50"), "H6os (CB4)");
|
||||
assert_eq!(control_board_code("Whatsminer", "H616", "M30S+"), "H616 (CB6)");
|
||||
// Unknown / blank pass through.
|
||||
assert_eq!(control_board_code("Antminer", "Unknown: FOO", "S19"), "Unknown: FOO");
|
||||
assert_eq!(control_board_code("Antminer", "", "S19"), "");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn control_board_cpu_and_board_split() {
|
||||
// CPU column vs board-code column.
|
||||
assert_eq!(control_board_cpu("Antminer", "AMLogic", "S19j Pro"), "AML");
|
||||
assert_eq!(control_board_board("Antminer", "AMLogic", "S19j Pro"), "C76");
|
||||
assert_eq!(control_board_cpu("Antminer", "CVITek", "S21 Pro"), "CVI");
|
||||
assert_eq!(control_board_board("Antminer", "CVITek", "S21 Pro"), "C88");
|
||||
assert_eq!(control_board_cpu("Whatsminer", "H616", "M30S+"), "H616");
|
||||
assert_eq!(control_board_board("Whatsminer", "H616", "M30S+"), "CB6");
|
||||
// S21 Pro on an AMLogic board is the 140mm CBE, not C76.
|
||||
assert_eq!(control_board_board("Antminer", "AMLogic", "S21 Pro"), "CBE");
|
||||
assert_eq!(control_board_code("Antminer", "AMLogic", "S21 Pro"), "AML (CBE)");
|
||||
// Unknown -> cpu holds the raw string, no board code.
|
||||
assert_eq!(control_board_cpu("Antminer", "Unknown: FOO", "S19"), "Unknown: FOO");
|
||||
assert_eq!(control_board_board("Antminer", "Unknown: FOO", "S19"), "");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn firmware_family_splits_vendor_prefix() {
|
||||
// Stock firmware: vendor word moves out of the family word (round 11 #6).
|
||||
assert_eq!(firmware_family("AntMiner Stock"), ("Stock".to_string(), Some("AntMiner".to_string())));
|
||||
assert_eq!(
|
||||
firmware_family("WhatsMiner Stock"),
|
||||
("Stock".to_string(), Some("WhatsMiner".to_string()))
|
||||
);
|
||||
// Aftermarket families pass through with no vendor prefix.
|
||||
assert_eq!(firmware_family("VNish"), ("VNish".to_string(), None));
|
||||
assert_eq!(firmware_family("Braiins"), ("Braiins".to_string(), None));
|
||||
// A bare vendor word with nothing after it is left as-is (not emptied).
|
||||
assert_eq!(firmware_family("AntMiner"), ("AntMiner".to_string(), None));
|
||||
// Firmware strings arrive from the network and may contain UTF-8 at
|
||||
// the byte position used to check a vendor prefix.
|
||||
let non_ascii = "AntMine\u{e9} Stock";
|
||||
assert_eq!(firmware_family(non_ascii), (non_ascii.to_string(), None));
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[ignore = "microbenchmark"]
|
||||
fn bench_naming_transforms() {
|
||||
let cases = [
|
||||
("Antminer", "S19jPro", "AntMiner Stock", "Xilinx"),
|
||||
("Antminer", "S21Pro", "VNish", "CVITek"),
|
||||
("Whatsminer", "M30SPlusVE40", "WhatsMiner Stock", "H616"),
|
||||
("Whatsminer", "M50SPlusPlusVK30", "Braiins", "H6"),
|
||||
];
|
||||
let iterations = 20_000;
|
||||
let started = std::time::Instant::now();
|
||||
for index in 0..iterations {
|
||||
let (make, model, firmware, board) = cases[index % cases.len()];
|
||||
let clean = clean_model(make, model);
|
||||
std::hint::black_box(firmware_family(firmware));
|
||||
std::hint::black_box(control_board_code(make, board, &clean));
|
||||
std::hint::black_box(chip_type_for_model(make, model));
|
||||
std::hint::black_box(clean);
|
||||
}
|
||||
let elapsed = started.elapsed();
|
||||
let per = elapsed / iterations as u32;
|
||||
println!("bench_naming_transforms: {per:?}/record");
|
||||
assert!(elapsed < std::time::Duration::from_millis(500));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn liquid_cooling_detection() {
|
||||
assert!(is_liquid_cooled("S21 XP Hydro"));
|
||||
assert!(is_liquid_cooled("Antminer S19 Hydro"));
|
||||
assert!(is_liquid_cooled("M53 immersion"));
|
||||
assert!(!is_liquid_cooled("S21 Pro"));
|
||||
assert!(!is_liquid_cooled("M30S++"));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,169 @@
|
||||
//! Dropdown presets + user-saved values for the Configure-pools dialog (round 15
|
||||
//! #1). Each pool field (address / account / worker / password) has a "+" menu
|
||||
//! offering built-in presets (pool stratums, worker placeholders) plus values the
|
||||
//! user has saved. "Add new..." opens a manager window that edits the whole saved
|
||||
//! list at once (round 18 #8b). Saved lists persist one-per-line under the config dir.
|
||||
|
||||
use std::path::PathBuf;
|
||||
|
||||
const CONFIG_DIR: &str = ".config/alkane-toolkit";
|
||||
|
||||
/// Which pool field a "+" menu belongs to.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum PoolField {
|
||||
Address,
|
||||
Account,
|
||||
Worker,
|
||||
Password,
|
||||
}
|
||||
|
||||
impl PoolField {
|
||||
fn saved_file(self) -> &'static str {
|
||||
match self {
|
||||
PoolField::Address => "pool-addresses.txt",
|
||||
PoolField::Account => "pool-accounts.txt",
|
||||
PoolField::Worker => "pool-workers.txt",
|
||||
PoolField::Password => "pool-passwords.txt",
|
||||
}
|
||||
}
|
||||
|
||||
/// Built-in presets offered before the user's saved values.
|
||||
pub fn presets(self) -> Vec<&'static str> {
|
||||
match self {
|
||||
// Top Bitcoin pools by hashrate with their primary stratum endpoints
|
||||
// (researched round 15; verify in-app before relying on any one).
|
||||
PoolField::Address => POOL_STRATUMS.iter().map(|(_, u)| *u).collect(),
|
||||
PoolField::Account => Vec::new(),
|
||||
// Per-miner worker-name placeholders (see MinerRow::expand_worker_template).
|
||||
PoolField::Worker => vec![
|
||||
"{ip1}", "{ip2}", "{ip3}", "{ip4}", "{serial}", "{mac}", "{nameplate-hr}",
|
||||
"{brand}", "{model}", "{submodel}", "{cpu}", "{cb}", "{firmware}", "{hostname}",
|
||||
],
|
||||
PoolField::Password => vec!["x"],
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// (pool name, primary stratum URL). Used for the address dropdown labels.
|
||||
pub const POOL_STRATUMS: &[(&str, &str)] = &[
|
||||
("Foundry USA", "stratum+tcp://btc.foundryusapool.com:3333"),
|
||||
("AntPool", "stratum+tcp://ss.antpool.com:3333"),
|
||||
("F2Pool", "stratum+tcp://btc.f2pool.com:1314"),
|
||||
("ViaBTC", "stratum+tcp://btc.viabtc.io:3333"),
|
||||
("SpiderPool", "stratum+tcp://btc-us.spiderpool.com:2309"),
|
||||
("Binance Pool", "stratum+tcp://bs.poolbinance.com:3333"),
|
||||
("Luxor", "stratum+tcp://btc.global.luxor.tech:700"),
|
||||
("SBI Crypto", "stratum+tcp://us1.sbicrypto.com:3333"),
|
||||
("Braiins Pool", "stratum+tcp://stratum.braiins.com:3333"),
|
||||
("ULTIMUSPOOL", "stratum+tcp://bs.ultimuspool.com:8888"),
|
||||
("SECPOOL", "stratum+tcp://btc.secpool.com:3333"),
|
||||
];
|
||||
|
||||
fn config_path(file: &str) -> PathBuf {
|
||||
let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
|
||||
PathBuf::from(home).join(CONFIG_DIR).join(file)
|
||||
}
|
||||
|
||||
/// The user's saved values for `field`, in save order (most recent last).
|
||||
pub fn load_saved(field: PoolField) -> Vec<String> {
|
||||
std::fs::read_to_string(config_path(field.saved_file()))
|
||||
.ok()
|
||||
.map(|s| s.lines().map(str::trim).filter(|l| !l.is_empty()).map(String::from).collect())
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
/// Replace `field`'s entire saved list with `values` (round 18 #8b: the preset
|
||||
/// manager edits the whole list at once). Each value is trimmed; empties, exact
|
||||
/// duplicates, and any value that is already a built-in preset are dropped.
|
||||
/// Returns the number of values actually written.
|
||||
pub fn save_all(field: PoolField, values: &[String]) -> std::io::Result<usize> {
|
||||
let out = dedupe_saved(&field.presets(), values);
|
||||
let p = config_path(field.saved_file());
|
||||
if let Some(dir) = p.parent() {
|
||||
let _ = std::fs::create_dir_all(dir);
|
||||
}
|
||||
// The password list can hold a pool password, so write it owner-only from the
|
||||
// moment it is created -- never briefly world-readable (round 18 #12).
|
||||
write_private(&p, out.join("\n").as_bytes())?;
|
||||
Ok(out.len())
|
||||
}
|
||||
|
||||
/// Write `data` to `path` with owner-only (0600) permissions from creation on
|
||||
/// Unix, so a secret is never momentarily world-readable between write and chmod.
|
||||
/// `mode()` only takes effect when the file is created, so an already-existing
|
||||
/// file is also re-tightened; elsewhere this is a plain write.
|
||||
fn write_private(path: &std::path::Path, data: &[u8]) -> std::io::Result<()> {
|
||||
#[cfg(unix)]
|
||||
{
|
||||
use std::io::Write;
|
||||
use std::os::unix::fs::{OpenOptionsExt, PermissionsExt};
|
||||
let mut f = std::fs::OpenOptions::new()
|
||||
.write(true)
|
||||
.create(true)
|
||||
.truncate(true)
|
||||
.mode(0o600)
|
||||
.open(path)?;
|
||||
let _ = std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o600));
|
||||
f.write_all(data)
|
||||
}
|
||||
#[cfg(not(unix))]
|
||||
{
|
||||
std::fs::write(path, data)
|
||||
}
|
||||
}
|
||||
|
||||
/// Trim every value, then drop empties, values equal to a built-in preset, and
|
||||
/// later exact duplicates (first occurrence wins). Order is otherwise preserved.
|
||||
fn dedupe_saved(presets: &[&str], values: &[String]) -> Vec<String> {
|
||||
let mut out: Vec<String> = Vec::new();
|
||||
for v in values {
|
||||
let v = v.trim();
|
||||
if v.is_empty() || presets.contains(&v) || out.iter().any(|s| s == v) {
|
||||
continue;
|
||||
}
|
||||
out.push(v.to_string());
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// The full dropdown list for a field: presets first, then the user's saved
|
||||
/// values. For the address field each entry is labelled with the pool name.
|
||||
pub fn dropdown_entries(field: PoolField) -> Vec<(String, String)> {
|
||||
// (label, value)
|
||||
let mut out: Vec<(String, String)> = Vec::new();
|
||||
if field == PoolField::Address {
|
||||
for (name, url) in POOL_STRATUMS {
|
||||
out.push((format!("{name} -- {url}"), url.to_string()));
|
||||
}
|
||||
} else {
|
||||
for p in field.presets() {
|
||||
out.push((p.to_string(), p.to_string()));
|
||||
}
|
||||
}
|
||||
for s in load_saved(field) {
|
||||
out.push((s.clone(), s));
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn dedupe_saved_trims_drops_empties_presets_and_dupes() {
|
||||
let presets = ["x", "{ip1}"];
|
||||
let vals: Vec<String> = [" ", "myworker", "myworker", "x", " keep ", "{ip1}", "keep"]
|
||||
.iter()
|
||||
.map(|s| s.to_string())
|
||||
.collect();
|
||||
// " " (empty), the second "myworker", "x"/"{ip1}" (presets) and the second
|
||||
// "keep" all drop; " keep " is trimmed and kept.
|
||||
assert_eq!(dedupe_saved(&presets, &vals), vec!["myworker".to_string(), "keep".to_string()]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn dedupe_saved_empty_input_is_empty() {
|
||||
assert!(dedupe_saved(&[], &[]).is_empty());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,155 @@
|
||||
//! Saved view presets: named snapshots of the table's column arrangement,
|
||||
//! visibility, sort, and filters. Persisted as JSON in the config dir. The
|
||||
//! first preset is always a built-in "Default" profile.
|
||||
|
||||
use std::collections::{HashMap, HashSet};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::model::{ColFilter, Column, ViewState, ALL_COLUMNS};
|
||||
use crate::scan::config_path;
|
||||
|
||||
pub const PRESETS_FILE: &str = "presets.json";
|
||||
|
||||
/// The built-in default profile's visible columns, in display order (Ip first):
|
||||
/// IP, model, health (component icons), hashrate, power, chip temp, firmware,
|
||||
/// CPU, access. The Health column (round 13 #3) replaced the old errors, boards
|
||||
/// (hashboard dots) and status columns.
|
||||
const DEFAULT_PROFILE: [Column; 10] = [
|
||||
Column::Ip,
|
||||
Column::Model,
|
||||
Column::Health,
|
||||
Column::Hashrate,
|
||||
Column::Power,
|
||||
Column::ChipTemp,
|
||||
Column::Firmware,
|
||||
Column::Cpu,
|
||||
Column::Locked,
|
||||
Column::Light,
|
||||
];
|
||||
|
||||
/// A serializable snapshot of a `ViewState` (Vec-based so JSON has no map keys
|
||||
/// that are enums, and column order within `visible` is preserved).
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct PresetView {
|
||||
pub order: Vec<Column>,
|
||||
pub visible: Vec<Column>,
|
||||
pub sort: Option<(Column, bool)>,
|
||||
pub filters: Vec<(Column, ColFilter)>,
|
||||
}
|
||||
|
||||
impl PresetView {
|
||||
pub fn from_view(v: &ViewState) -> PresetView {
|
||||
PresetView {
|
||||
order: v.order.clone(),
|
||||
// keep the visible columns in display order for stability
|
||||
visible: v.order.iter().copied().filter(|c| v.visible.contains(c)).collect(),
|
||||
sort: v.sort,
|
||||
filters: v.filters.iter().map(|(k, f)| (*k, f.clone())).collect(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Rebuild a `ViewState` from this snapshot. Any column missing from a
|
||||
/// loaded (possibly older) preset is appended to `order` and left hidden, so
|
||||
/// the result always covers every `Column`.
|
||||
pub fn to_view(&self) -> ViewState {
|
||||
let mut order = self.order.clone();
|
||||
for c in ALL_COLUMNS {
|
||||
if !order.contains(&c) {
|
||||
order.push(c);
|
||||
}
|
||||
}
|
||||
let mut visible: HashSet<Column> = self.visible.iter().copied().collect();
|
||||
visible.insert(Column::Ip); // IP is always shown
|
||||
let filters: HashMap<Column, ColFilter> = self.filters.iter().cloned().collect();
|
||||
ViewState { order, visible, sort: self.sort, filters }
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct Preset {
|
||||
pub name: String,
|
||||
pub view: PresetView,
|
||||
}
|
||||
|
||||
/// The built-in default profile (always present as the first preset).
|
||||
pub fn default_preset() -> Preset {
|
||||
let mut order: Vec<Column> = DEFAULT_PROFILE.to_vec();
|
||||
for c in ALL_COLUMNS {
|
||||
if !order.contains(&c) {
|
||||
order.push(c);
|
||||
}
|
||||
}
|
||||
Preset {
|
||||
name: "Default".to_string(),
|
||||
view: PresetView {
|
||||
order,
|
||||
visible: DEFAULT_PROFILE.to_vec(),
|
||||
sort: None,
|
||||
filters: Vec::new(),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/// Load saved presets, always with the built-in "Default" first. A missing or
|
||||
/// unreadable file yields just the default.
|
||||
pub fn load_presets() -> Vec<Preset> {
|
||||
let mut presets = std::fs::read_to_string(config_path(PRESETS_FILE))
|
||||
.ok()
|
||||
.and_then(|s| serde_json::from_str::<Vec<Preset>>(&s).ok())
|
||||
.unwrap_or_default();
|
||||
// The default profile is always present and always first.
|
||||
presets.retain(|p| p.name != "Default");
|
||||
presets.insert(0, default_preset());
|
||||
presets
|
||||
}
|
||||
|
||||
/// Persist presets (the built-in "Default" is not written; it is re-seeded on
|
||||
/// load). Best-effort: errors are returned for the caller to surface.
|
||||
pub fn save_presets(presets: &[Preset]) -> std::io::Result<()> {
|
||||
let p = config_path(PRESETS_FILE);
|
||||
if let Some(dir) = p.parent() {
|
||||
std::fs::create_dir_all(dir)?;
|
||||
}
|
||||
let user: Vec<&Preset> = presets.iter().filter(|p| p.name != "Default").collect();
|
||||
let json = serde_json::to_string_pretty(&user)
|
||||
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;
|
||||
std::fs::write(p, json)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn default_preset_round_trips_through_view() {
|
||||
let p = default_preset();
|
||||
let view = p.view.to_view();
|
||||
// IP first + the requested default columns visible.
|
||||
assert!(view.visible.contains(&Column::Ip));
|
||||
assert!(view.visible.contains(&Column::Model));
|
||||
assert!(view.visible.contains(&Column::Health));
|
||||
assert!(view.visible.contains(&Column::Cpu));
|
||||
assert!(view.visible.contains(&Column::Locked));
|
||||
// The Health column (round 13 #3) replaced these in the default profile.
|
||||
assert!(!view.visible.contains(&Column::Error));
|
||||
// Columns dropped from the default profile in round 11.
|
||||
assert!(!view.visible.contains(&Column::BoardCode), "not in the default profile");
|
||||
assert!(!view.visible.contains(&Column::Fan1), "not in the default profile");
|
||||
// to_view covers every column in `order`.
|
||||
assert_eq!(view.order.len(), ALL_COLUMNS.len());
|
||||
// Round-trip a snapshot back out.
|
||||
let snap = PresetView::from_view(&view);
|
||||
assert_eq!(snap.visible.first(), Some(&Column::Ip));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn preset_json_round_trip() {
|
||||
let p = default_preset();
|
||||
let json = serde_json::to_string(&vec![&p]).unwrap();
|
||||
let back: Vec<Preset> = serde_json::from_str(&json).unwrap();
|
||||
assert_eq!(back.len(), 1);
|
||||
assert_eq!(back[0].name, "Default");
|
||||
assert_eq!(back[0].view.visible, DEFAULT_PROFILE.to_vec());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,425 @@
|
||||
//! Restore an aftermarket-firmware miner to stock (round 12 #8a).
|
||||
//!
|
||||
//! All three supported aftermarket firmwares ship a free, self-restoring revert
|
||||
//! (the stock image is retained on-device at install time; no image is uploaded):
|
||||
//! - VNish: POST /api/v1/unlock -> bearer -> POST /api/v1/firmware/remove
|
||||
//! - LuxOS: luxminer :4028 {"command":"logon"} -> SessionID ->
|
||||
//! {"command":"uninstallluxos","parameter":"<SessionID>"}
|
||||
//! - Braiins: SSH `uninstall.sh` (re-flashes the on-NAND stock backup)
|
||||
//!
|
||||
//! DESTRUCTIVE: this removes the running aftermarket firmware and reboots the
|
||||
//! miner to stock. It is gated behind a typed confirmation in the UI and runs on
|
||||
//! a background thread so the reboot latency never blocks the event loop. The
|
||||
//! flows are documented + live-confirmed in the miner-firmware wiki
|
||||
//! (40-boot-os-and-build/firmware-install-remove-api and siblings).
|
||||
|
||||
use std::io::{Read, Write};
|
||||
use std::net::{SocketAddr, TcpStream};
|
||||
use std::process::Command;
|
||||
use std::sync::Arc;
|
||||
use std::sync::atomic::{AtomicBool, Ordering};
|
||||
use std::sync::mpsc::{Receiver, channel};
|
||||
use std::time::Duration;
|
||||
|
||||
use crate::scan::fake_scan_enabled;
|
||||
|
||||
pub enum RestoreMsg {
|
||||
Started,
|
||||
Result { ip: String, ok: bool, detail: String },
|
||||
Done,
|
||||
}
|
||||
|
||||
pub struct RestoreHandle {
|
||||
pub rx: Receiver<RestoreMsg>,
|
||||
// The worker honours cancellation between miners (see `tc` below); a UI stop
|
||||
// control is not wired yet, so the handle-side trigger is kept for when it is.
|
||||
#[allow(dead_code)]
|
||||
cancel: Arc<AtomicBool>,
|
||||
}
|
||||
|
||||
impl RestoreHandle {
|
||||
#[allow(dead_code)]
|
||||
pub fn stop(&self) {
|
||||
self.cancel.store(true, Ordering::Relaxed);
|
||||
}
|
||||
}
|
||||
|
||||
/// One miner to restore: its IP plus the firmware family ("VNish"/"LuxOS"/
|
||||
/// "Braiins") that selects the revert flow.
|
||||
pub struct RestoreTarget {
|
||||
pub ip: String,
|
||||
pub firmware: String,
|
||||
}
|
||||
|
||||
/// Start restoring the given miners to stock on a background thread. `vnish_pass`
|
||||
/// is the VNish web password; `ssh_user`/`ssh_pass` drive the Braiins SSH revert.
|
||||
pub fn start_restore(
|
||||
targets: Vec<RestoreTarget>,
|
||||
vnish_pass: String,
|
||||
ssh_user: String,
|
||||
ssh_pass: String,
|
||||
) -> RestoreHandle {
|
||||
let (tx, rx) = channel();
|
||||
let cancel = Arc::new(AtomicBool::new(false));
|
||||
|
||||
if fake_scan_enabled() {
|
||||
// Offline demo: report each target as restored without touching anything.
|
||||
let _ = tx.send(RestoreMsg::Started);
|
||||
for t in targets {
|
||||
let _ = tx.send(RestoreMsg::Result {
|
||||
ip: t.ip,
|
||||
ok: true,
|
||||
detail: "restored to stock (demo)".into(),
|
||||
});
|
||||
}
|
||||
let _ = tx.send(RestoreMsg::Done);
|
||||
return RestoreHandle { rx, cancel };
|
||||
}
|
||||
|
||||
let tc = cancel.clone();
|
||||
let err_tx = tx.clone();
|
||||
let spawned = std::thread::Builder::new()
|
||||
.name("restore-stock".into())
|
||||
.spawn(move || {
|
||||
let _ = tx.send(RestoreMsg::Started);
|
||||
for t in targets {
|
||||
if tc.load(Ordering::Relaxed) {
|
||||
break;
|
||||
}
|
||||
let (ok, detail) = restore_one(&t, &vnish_pass, &ssh_user, &ssh_pass);
|
||||
if tx.send(RestoreMsg::Result { ip: t.ip, ok, detail }).is_err() {
|
||||
return;
|
||||
}
|
||||
}
|
||||
let _ = tx.send(RestoreMsg::Done);
|
||||
});
|
||||
if spawned.is_err() {
|
||||
// Never leave the restore subsystem wedged (round 18 #12): if the worker
|
||||
// thread can't start, emit a failure + Done so the drain clears the handle.
|
||||
let _ = err_tx.send(RestoreMsg::Result {
|
||||
ip: String::new(),
|
||||
ok: false,
|
||||
detail: "could not start the restore worker thread".into(),
|
||||
});
|
||||
let _ = err_tx.send(RestoreMsg::Done);
|
||||
}
|
||||
RestoreHandle { rx, cancel }
|
||||
}
|
||||
|
||||
fn restore_one(t: &RestoreTarget, vnish_pass: &str, ssh_user: &str, ssh_pass: &str) -> (bool, String) {
|
||||
let fw = t.firmware.to_ascii_lowercase();
|
||||
if fw.contains("vnish") || fw.contains("wildrose") || fw.contains("anthill") {
|
||||
restore_vnish(&t.ip, vnish_pass)
|
||||
} else if fw.contains("lux") {
|
||||
restore_luxos(&t.ip)
|
||||
} else if fw.contains("braiins") || fw.contains("bos") {
|
||||
restore_braiins(&t.ip, ssh_user, ssh_pass)
|
||||
} else {
|
||||
(false, format!("no restore-to-stock path for firmware '{}'", t.firmware))
|
||||
}
|
||||
}
|
||||
|
||||
/// VNish: unlock -> bearer -> firmware/remove (self-restores + reboots ~3 s).
|
||||
fn restore_vnish(ip: &str, pass: &str) -> (bool, String) {
|
||||
// serde-encode the body so a password with a quote/backslash can't break the
|
||||
// JSON, and send it via stdin (-d @-) so the password never appears on curl's
|
||||
// argv / the process list (round 18 #12).
|
||||
let body = serde_json::json!({ "pw": pass }).to_string();
|
||||
let unlock = match curl(
|
||||
&[
|
||||
"-s", "--connect-timeout", "5", "--max-time", "9",
|
||||
"-X", "POST", "-H", "Content-Type: application/json",
|
||||
"-d", "@-",
|
||||
&format!("http://{ip}/api/v1/unlock"),
|
||||
],
|
||||
Some(body.as_bytes()),
|
||||
) {
|
||||
Ok(s) => s,
|
||||
Err(e) => return (false, format!("unlock request failed: {e}")),
|
||||
};
|
||||
let token = serde_json::from_str::<serde_json::Value>(&unlock)
|
||||
.ok()
|
||||
.and_then(|v| v.get("token").and_then(|t| t.as_str()).map(str::to_string))
|
||||
.filter(|t| !t.is_empty());
|
||||
let Some(token) = token else {
|
||||
return (false, "VNish unlock rejected (wrong web password?)".into());
|
||||
};
|
||||
match curl(
|
||||
&[
|
||||
"-s", "--connect-timeout", "5", "--max-time", "12",
|
||||
"-X", "POST", "-H", &format!("Authorization: Bearer {token}"),
|
||||
&format!("http://{ip}/api/v1/firmware/remove"),
|
||||
],
|
||||
None,
|
||||
) {
|
||||
// The miner reverts + reboots after ~3 s; the response is {"after":N}.
|
||||
Ok(resp) if resp.contains("after") => (true, "reverting to stock (~3 s)".into()),
|
||||
Ok(resp) => (false, format!("firmware/remove returned: {}", resp.trim())),
|
||||
Err(e) => (false, format!("firmware/remove failed: {e}")),
|
||||
}
|
||||
}
|
||||
|
||||
/// LuxOS: credential-free luxminer session, then uninstallluxos (reboots to stock).
|
||||
fn restore_luxos(ip: &str) -> (bool, String) {
|
||||
let logon = match lux_rpc(ip, "{\"command\":\"logon\"}") {
|
||||
Ok(s) => s,
|
||||
Err(e) => return (false, format!("logon failed: {e}")),
|
||||
};
|
||||
let session = serde_json::from_str::<serde_json::Value>(&logon)
|
||||
.ok()
|
||||
.and_then(|v| {
|
||||
v.pointer("/SESSION/0/SessionID")
|
||||
.or_else(|| v.pointer("/Session/0/SessionID"))
|
||||
.and_then(|s| s.as_str())
|
||||
.map(str::to_string)
|
||||
});
|
||||
let Some(session) = session.filter(|s| !s.is_empty()) else {
|
||||
return (false, format!("no SessionID in logon response: {}", logon.trim()));
|
||||
};
|
||||
// serde-encode so the miner-supplied SessionID can't break or inject into the
|
||||
// JSON-RPC command (round 18 #12).
|
||||
let cmd = serde_json::json!({ "command": "uninstallluxos", "parameter": session }).to_string();
|
||||
match lux_rpc(ip, &cmd) {
|
||||
// Code 350 "Uninstalling LuxOS"; the miner reboots + reverts in background.
|
||||
Ok(resp) if resp.contains("350") || resp.to_lowercase().contains("uninstall") => {
|
||||
(true, "uninstalling LuxOS (reboots to stock)".into())
|
||||
}
|
||||
// The miner reboots as it reverts, so the reply is often dropped/empty
|
||||
// after the command is accepted. The logon above already proved the miner
|
||||
// was reachable, so an empty reply or a dropped connection here is the
|
||||
// expected reboot, not a failure (round 18 #12).
|
||||
Ok(resp) if resp.trim().is_empty() => {
|
||||
(true, "uninstall accepted (miner rebooting to stock)".into())
|
||||
}
|
||||
Ok(resp) => (false, format!("uninstallluxos returned: {}", resp.trim())),
|
||||
Err(e)
|
||||
if ["closed", "reset", "timed out", "broken pipe", "eof"]
|
||||
.iter()
|
||||
.any(|m| e.to_lowercase().contains(m)) =>
|
||||
{
|
||||
(true, "RPC dropped (miner rebooting to stock)".into())
|
||||
}
|
||||
Err(e) => (false, format!("uninstallluxos failed: {e}")),
|
||||
}
|
||||
}
|
||||
|
||||
/// Braiins: SSH `uninstall.sh` (re-flashes the retained on-NAND stock backup).
|
||||
fn restore_braiins(ip: &str, user: &str, pass: &str) -> (bool, String) {
|
||||
if pass.is_empty() {
|
||||
return (false, "Braiins restore needs an SSH password (set the SSH login)".into());
|
||||
}
|
||||
let target = format!("{user}@{ip}");
|
||||
// sshpass reads the password from $SSHPASS (-e) rather than argv (-p), so it
|
||||
// never shows up in the process list (round 18 #12). Host-key checking is
|
||||
// deliberately disabled: these are LAN miners whose SSH host key changes on
|
||||
// every reflash, so pinning it would break the very revert this performs.
|
||||
// BatchMode stops any interactive prompt from hanging out the 60 s cap.
|
||||
let mut cmd = Command::new("sshpass");
|
||||
cmd.env("SSHPASS", pass);
|
||||
cmd.arg("-e").arg("ssh");
|
||||
cmd.args([
|
||||
"-o", "StrictHostKeyChecking=no",
|
||||
"-o", "UserKnownHostsFile=/dev/null",
|
||||
"-o", "BatchMode=yes",
|
||||
"-o", "ConnectTimeout=8",
|
||||
&target,
|
||||
"uninstall.sh || /sbin/uninstall.sh",
|
||||
]);
|
||||
match run_with_timeout(cmd, Duration::from_secs(60), None) {
|
||||
Ok(out) => classify_braiins(
|
||||
&String::from_utf8_lossy(&out.stdout),
|
||||
&String::from_utf8_lossy(&out.stderr),
|
||||
out.code,
|
||||
out.timed_out,
|
||||
),
|
||||
Err(e) => {
|
||||
if e.contains("closed") || e.contains("reset") || e.contains("timed out") {
|
||||
(true, "SSH dropped (miner likely rebooting to stock)".into())
|
||||
} else {
|
||||
(false, format!("SSH uninstall failed: {e}"))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Decide a Braiins `uninstall.sh` outcome from its captured output. The critical
|
||||
/// rule (round 18 #12): an SSH auth/connection failure -- which writes its
|
||||
/// diagnostic to stderr, leaves stdout empty, and exits non-zero -- must be
|
||||
/// reported as a FAILURE, never a false success. A dropped connection or a
|
||||
/// timeout after the command started is the expected signature of the reboot.
|
||||
fn classify_braiins(stdout: &str, stderr: &str, code: Option<i32>, timed_out: bool) -> (bool, String) {
|
||||
let err = stderr.to_lowercase();
|
||||
// ssh's own connection/auth failures (exit 255) never reach the remote command.
|
||||
let conn_fail = [
|
||||
"permission denied",
|
||||
"connection refused",
|
||||
"could not resolve",
|
||||
"no route to host",
|
||||
"connection timed out",
|
||||
"operation timed out",
|
||||
"host key verification failed",
|
||||
"before authentication",
|
||||
]
|
||||
.iter()
|
||||
.any(|m| err.contains(m));
|
||||
if conn_fail {
|
||||
let why = stderr.lines().map(str::trim).rfind(|l| !l.is_empty());
|
||||
return (false, format!("SSH failed: {}", why.unwrap_or("connection/auth error")));
|
||||
}
|
||||
let out = stdout.to_lowercase();
|
||||
if out.contains("not found") || out.contains("no such") || err.contains("not found") {
|
||||
return (false, "uninstall.sh not found on the miner".into());
|
||||
}
|
||||
match code {
|
||||
Some(0) => (true, "ran uninstall.sh (reverts to stock + reboots)".into()),
|
||||
None => (true, "SSH dropped (miner likely rebooting to stock)".into()),
|
||||
_ if timed_out => (true, "SSH timed out (miner likely rebooting to stock)".into()),
|
||||
Some(c) => (false, format!("uninstall.sh exited {c}: {}", stderr.trim())),
|
||||
}
|
||||
}
|
||||
|
||||
/// One luxminer :4028 request/response (line-framed, socket closes after reply).
|
||||
fn lux_rpc(ip: &str, payload: &str) -> Result<String, String> {
|
||||
let addr: SocketAddr = format!("{ip}:4028").parse().map_err(|e| format!("bad addr: {e}"))?;
|
||||
let t = Duration::from_secs(8);
|
||||
let mut s = TcpStream::connect_timeout(&addr, t).map_err(|e| e.to_string())?;
|
||||
s.set_read_timeout(Some(t)).ok();
|
||||
s.set_write_timeout(Some(t)).ok();
|
||||
s.write_all(payload.as_bytes()).map_err(|e| e.to_string())?;
|
||||
let mut buf = Vec::new();
|
||||
let mut chunk = [0u8; 4096];
|
||||
loop {
|
||||
match s.read(&mut chunk) {
|
||||
Ok(0) => break,
|
||||
Ok(n) => {
|
||||
buf.extend_from_slice(&chunk[..n]);
|
||||
if buf.len() > 1 << 16 {
|
||||
break;
|
||||
}
|
||||
}
|
||||
Err(_) => break,
|
||||
}
|
||||
}
|
||||
Ok(String::from_utf8_lossy(&buf).trim_matches('\u{0}').to_string())
|
||||
}
|
||||
|
||||
/// The captured result of a timed subprocess run.
|
||||
struct CmdOutput {
|
||||
/// The process exit code, or `None` if it was killed / dropped / timed out.
|
||||
code: Option<i32>,
|
||||
stdout: Vec<u8>,
|
||||
stderr: Vec<u8>,
|
||||
timed_out: bool,
|
||||
}
|
||||
|
||||
/// curl with a wall-clock cap. Errors only when the run produced no output and
|
||||
/// timed out (a black-holed host); otherwise returns stdout even on a non-zero
|
||||
/// exit (curl prints useful bodies/status on failures).
|
||||
fn curl(args: &[&str], stdin_data: Option<&[u8]>) -> Result<String, String> {
|
||||
let mut cmd = Command::new("curl");
|
||||
cmd.args(args);
|
||||
let out = run_with_timeout(cmd, Duration::from_secs(15), stdin_data)?;
|
||||
if out.timed_out && out.stdout.is_empty() {
|
||||
return Err("timed out".into());
|
||||
}
|
||||
Ok(String::from_utf8_lossy(&out.stdout).into_owned())
|
||||
}
|
||||
|
||||
/// Run a command with a hard wall-clock timeout, capturing stdout, stderr, and
|
||||
/// the exit code. Both pipes are drained on their own threads so a child that
|
||||
/// writes a lot to stderr can never deadlock against a full pipe (round 18 #12).
|
||||
/// `stdin_data`, when set, is written to the child's stdin and the pipe closed
|
||||
/// (used to feed a request body without putting a secret on argv).
|
||||
fn run_with_timeout(
|
||||
mut cmd: Command,
|
||||
timeout: Duration,
|
||||
stdin_data: Option<&[u8]>,
|
||||
) -> Result<CmdOutput, String> {
|
||||
cmd.stdout(std::process::Stdio::piped());
|
||||
cmd.stderr(std::process::Stdio::piped());
|
||||
if stdin_data.is_some() {
|
||||
cmd.stdin(std::process::Stdio::piped());
|
||||
}
|
||||
let mut child = cmd.spawn().map_err(|e| format!("spawn: {e}"))?;
|
||||
if let Some(data) = stdin_data {
|
||||
if let Some(mut si) = child.stdin.take() {
|
||||
let _ = si.write_all(data);
|
||||
} // dropping `si` closes the pipe
|
||||
}
|
||||
let mut stdout = child.stdout.take().ok_or("no stdout")?;
|
||||
let mut stderr = child.stderr.take().ok_or("no stderr")?;
|
||||
let out_reader = std::thread::spawn(move || {
|
||||
let mut b = Vec::new();
|
||||
let _ = stdout.read_to_end(&mut b);
|
||||
b
|
||||
});
|
||||
let err_reader = std::thread::spawn(move || {
|
||||
let mut b = Vec::new();
|
||||
let _ = stderr.read_to_end(&mut b);
|
||||
b
|
||||
});
|
||||
let start = std::time::Instant::now();
|
||||
let mut timed_out = false;
|
||||
let status = loop {
|
||||
match child.try_wait().map_err(|e| e.to_string())? {
|
||||
Some(s) => break Some(s),
|
||||
None => {
|
||||
if start.elapsed() >= timeout {
|
||||
let _ = child.kill();
|
||||
let _ = child.wait(); // reap so we never leave a zombie
|
||||
timed_out = true;
|
||||
break None;
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(50));
|
||||
}
|
||||
}
|
||||
};
|
||||
Ok(CmdOutput {
|
||||
code: status.and_then(|s| s.code()),
|
||||
stdout: out_reader.join().unwrap_or_default(),
|
||||
stderr: err_reader.join().unwrap_or_default(),
|
||||
timed_out,
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn braiins_auth_or_connection_failure_is_not_a_false_success() {
|
||||
// The critical regression guard (round 18 #12): a wrong password or an
|
||||
// unreachable miner writes to stderr, leaves stdout empty, and exits
|
||||
// non-zero -- it must report failure, never "restored".
|
||||
let (ok, msg) = classify_braiins("", "Permission denied, please try again.", Some(255), false);
|
||||
assert!(!ok, "wrong password must not report success");
|
||||
assert!(msg.to_lowercase().contains("ssh failed"), "{msg}");
|
||||
|
||||
let (ok, _) = classify_braiins("", "ssh: connect to host 10.0.0.9 port 22: Connection refused", Some(255), false);
|
||||
assert!(!ok, "unreachable miner must not report success");
|
||||
|
||||
let (ok, _) = classify_braiins("", "ssh: Could not resolve hostname miner: Name or service not known", Some(255), false);
|
||||
assert!(!ok, "unresolvable host must not report success");
|
||||
|
||||
// Genuine outcomes.
|
||||
let (ok, _) = classify_braiins("uninstalling...\n", "", Some(0), false);
|
||||
assert!(ok, "clean exit 0 is success");
|
||||
let (ok, _) = classify_braiins("", "Connection to 10.0.0.5 closed by remote host.", None, false);
|
||||
assert!(ok, "connection dropped mid-command (reboot) is success");
|
||||
let (ok, _) = classify_braiins("", "", None, true);
|
||||
assert!(ok, "timeout after the command started (reboot) is success");
|
||||
let (ok, _) = classify_braiins("bash: uninstall.sh: command not found\n", "", Some(127), false);
|
||||
assert!(!ok, "missing uninstall.sh is a failure");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn firmware_selects_the_right_flow() {
|
||||
// The dispatcher only recognises the three revertible aftermarket
|
||||
// families; anything else has no restore path.
|
||||
let mk = |fw: &str| RestoreTarget { ip: "0.0.0.0".into(), firmware: fw.into() };
|
||||
// Unknown firmware is rejected cleanly (no network attempt in the branch).
|
||||
let (ok, detail) = restore_one(&mk("Stock"), "", "", "");
|
||||
assert!(!ok);
|
||||
assert!(detail.contains("no restore-to-stock path"), "{detail}");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
# cargo-deny configuration (https://embarkstudios.github.io/cargo-deny/).
|
||||
#
|
||||
# Run locally with `cargo deny check`. CI's security gate is cargo-audit (lighter,
|
||||
# already wired); this file documents the dependency policy and lets anyone run a
|
||||
# fuller license/advisory/source check. The whole dependency set is vendored under
|
||||
# ./vendor and resolved offline (see .cargo/config.toml).
|
||||
|
||||
[advisories]
|
||||
version = 2
|
||||
# Accepted, documented advisories (build-time-only reqwest 0.11 subtree of the
|
||||
# wx-rs build script -- never linked into the runtime binary). Mirrors
|
||||
# .cargo/audit.toml; re-review when the vendored dependency set is refreshed.
|
||||
ignore = [
|
||||
"RUSTSEC-2026-0258", # h2 0.3 DATA-frame DoS (build-time HTTP client only)
|
||||
"RUSTSEC-2025-0134", # rustls-pemfile 1.0.4 unmaintained (same subtree)
|
||||
]
|
||||
|
||||
[licenses]
|
||||
version = 2
|
||||
# The project is MIT; only permissive licenses are allowed in the
|
||||
# dependency tree.
|
||||
allow = [
|
||||
"MIT",
|
||||
"Apache-2.0",
|
||||
"Apache-2.0 WITH LLVM-exception",
|
||||
"BSD-2-Clause",
|
||||
"BSD-3-Clause",
|
||||
"ISC",
|
||||
"Zlib",
|
||||
"Unicode-3.0",
|
||||
"Unicode-DFS-2016",
|
||||
"MPL-2.0",
|
||||
"CC0-1.0",
|
||||
]
|
||||
confidence-threshold = 0.9
|
||||
|
||||
[bans]
|
||||
multiple-versions = "warn"
|
||||
wildcards = "allow"
|
||||
|
||||
[sources]
|
||||
unknown-registry = "warn"
|
||||
unknown-git = "warn"
|
||||
@@ -1,10 +1,10 @@
|
||||
# UI Spec — primary view
|
||||
# Primary view
|
||||
|
||||
Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
|
||||
|
||||
## Header (above the table)
|
||||
## Header
|
||||
|
||||
- **KPI block, top left — 6 KPIs:**
|
||||
- **KPI block, top left: 6 KPIs:**
|
||||
1. Total miners
|
||||
2. Hashing
|
||||
3. Slow
|
||||
@@ -31,7 +31,7 @@ Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
|
||||
4. Cooling (fan)
|
||||
5. Firmware
|
||||
6. Pool worker account name
|
||||
7. …then the remaining statistics in registry order.
|
||||
7. Remaining statistics in registry order.
|
||||
|
||||
## Data sources
|
||||
|
||||
@@ -45,10 +45,10 @@ Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
|
||||
ships with the board registry; missing band = excluded from Slow, counted
|
||||
in Hashing).
|
||||
|
||||
## Implementation notes
|
||||
## Implementation
|
||||
|
||||
- wxWidgets: the view is a `wxDataViewListCtrl`/`wxDataViewCtrl` (virtual
|
||||
list — thousands of rows without materializing cells), checkbox column +
|
||||
list for thousands of rows without materializing cells), checkbox column +
|
||||
IP column fixed via attribute/serializer, drag reorder via `wxReorderable`
|
||||
column events, sort via column header click events mapped to the model.
|
||||
- Filter panel: per-column distinct-value checklist with text search,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ADR 0001: Recipes as data, interpreted by one engine
|
||||
# ADR 0001: Recipe engine
|
||||
|
||||
Status: ACCEPTED
|
||||
Date: 2026-09-14
|
||||
|
||||
@@ -1,41 +1,27 @@
|
||||
# ADR 0002: GUI bindings — wxWidgets shell in C++ + Rust core, spike to revisit
|
||||
# ADR 0002: GUI bindings
|
||||
|
||||
Status: RESOLVED 2026-09-15 - the operator chose Option B (pure Rust via
|
||||
wx-rs) with vendoring (ADR-0003). wx-rs 0.2.0 was extended via the patch
|
||||
queue: Linux/GTK3 wx-config build path plus the widget bridge (panel,
|
||||
sizers, static text, button, text ctrl, checkbox, checklistbox, dialog,
|
||||
data view list ctrl, timer). The app ships this way; no C++ shell.
|
||||
Date: 2026-09-14
|
||||
Resolved: 2026-09-15
|
||||
|
||||
## Context
|
||||
|
||||
The toolkit must present a native cross-platform GUI (wxWidgets chosen).
|
||||
Rust bindings to wxWidgets checked on crates.io 2026-09-14:
|
||||
|
||||
- `wxRust` 0.0.1-alpha — unmaintained since 2022.
|
||||
- `wx-rs` 0.2.0 (2023, self-contained) — ~6k downloads, no 1.0.
|
||||
|
||||
Betting the GUI on alpha bindings risks weeks of binding-gap debugging
|
||||
(paste-heavy widgets, worker threads + event loops, GTK/WinCocoa quirks).
|
||||
The toolkit needs a native wxWidgets GUI. At the time of evaluation,
|
||||
`wxRust` 0.0.1-alpha had seen no maintenance since 2022, and `wx-rs`
|
||||
0.2.0 lacked widgets needed for the Toolkit.
|
||||
|
||||
## Decision
|
||||
|
||||
Default: **thin C++17 wxWidgets shell (`gui/`) + Rust core exposed over a
|
||||
small stable C ABI** (cdylib from `alkane-core`, header generated with
|
||||
cbindgen). The shell holds frames, lists, the install wizard, and event
|
||||
glue only — no business logic, no safety logic. All invariants, engines,
|
||||
and tests live in Rust where they are testable headlessly.
|
||||
The operator chose a Rust GUI through a vendored, patched `wx-rs` 0.2.0.
|
||||
The patch queue adds the Linux/GTK3 build path and bindings for panels,
|
||||
sizers, controls, dialogs, data views, timers, and event dispatch. The
|
||||
application uses this bridge; it has no separate C++ shell.
|
||||
|
||||
Gate: M0 runs a time-boxed `wx-rs` spike (window + list/tree + wizard flow
|
||||
+ worker-thread progress + cancel on Linux and Windows). If the spike is
|
||||
solid, flip to pure Rust; either way the decision is recorded before M3.
|
||||
The original proposal was a small C++17 wxWidgets shell calling a Rust
|
||||
core through a C ABI. The `wx-rs` spike met the GUI need, so that proposal
|
||||
was not adopted.
|
||||
|
||||
## Consequences
|
||||
|
||||
- The repo builds two things: a Rust workspace and a small C++ app linked
|
||||
against the core cdylib. CMake in `gui/`.
|
||||
- Core API surface stays small and event-oriented (discover, identify,
|
||||
plan, execute, cancel, progress events, log tail) — good FFI hygiene and
|
||||
a natural match for the CLI too (D4).
|
||||
- If wx-rs wins the spike, the C ABI is kept as an integration boundary for
|
||||
scripted/HIL use anyway.
|
||||
- Keep business logic and safety checks in testable Rust code.
|
||||
- Carry wx-rs changes as numbered patches under `thirdparty/wx-rs/patches`.
|
||||
- Recheck the bridge on Linux, Windows, and macOS packaging changes.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ADR 0003: Vendoring policy — pristine upstream archives + patch queue
|
||||
# ADR 0003: Vendoring
|
||||
|
||||
Status: ACCEPTED
|
||||
Date: 2026-09-15
|
||||
@@ -20,7 +20,15 @@ vendor/ cargo-managed crate sources ONLY (regenerated by
|
||||
`cargo vendor vendor`; it deletes unmanaged dirs - never
|
||||
put hand-made trees here; learned the hard way)
|
||||
thirdparty/
|
||||
asic-rs lives in vendor/ (pure crates.io dep, cargo-vendored)
|
||||
asic-rs the vendored crates live in vendor/ (crates.io dep,
|
||||
VERSION cargo-vendored); this dir holds their patch queue:
|
||||
patches/ 0001 whatsminer set_power_limit error propagation (#4)
|
||||
refresh-checksums.py rewrites a vendored crate's .cargo-checksum.json
|
||||
after a patch (cargo verifies each file's SHA256)
|
||||
The committed vendor/ tree has the patches applied and the
|
||||
affected .cargo-checksum.json refreshed, so builds need
|
||||
nothing extra. On re-vendor, run
|
||||
scripts/apply-asic-rs-patches.sh to re-apply + refresh.
|
||||
wxwidgets/
|
||||
wxWidgets-3.3.3/ pristine release tree, never edited directly
|
||||
VERSION upstream version + tarball URL + sha256
|
||||
@@ -34,7 +42,7 @@ thirdparty/
|
||||
|
||||
Rules:
|
||||
|
||||
1. Never edit a vendored pristine tree in place — every local change is a
|
||||
1. Never edit a vendored pristine tree in place. Every local change is a
|
||||
patch in `patches/`, applied by the build in numeric order. This makes
|
||||
an upstream update: replace pristine archive, `git apply` surviving
|
||||
patches, rebase the rest.
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
#!/bin/bash
|
||||
# Re-apply the asic-rs patch queue to the cargo-vendored tree and refresh the
|
||||
# affected crates' .cargo-checksum.json. Run this after `cargo vendor vendor`
|
||||
# (which regenerates a pristine vendor/ and drops our edits). A normal build
|
||||
# does NOT need this -- the committed vendor/ tree already has the patches
|
||||
# applied and checksums refreshed; this is the re-vendoring recipe (ADR 0003).
|
||||
set -euo pipefail
|
||||
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
cd "$REPO"
|
||||
|
||||
PATCHES_DIR="thirdparty/asic-rs/patches"
|
||||
shopt -s nullglob
|
||||
patches=("$PATCHES_DIR"/*.patch)
|
||||
if [ ${#patches[@]} -eq 0 ]; then
|
||||
echo "no patches in $PATCHES_DIR"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
for p in "${patches[@]}"; do
|
||||
echo "== applying $p =="
|
||||
if git apply --check -p1 "$p" 2>/dev/null; then
|
||||
git apply -p1 "$p"
|
||||
elif git apply --check -p1 --reverse "$p" 2>/dev/null; then
|
||||
echo " (already applied -- skipping)"
|
||||
else
|
||||
echo "ERROR: $p does not apply cleanly; resolve manually." >&2
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
echo "== refreshing checksums for all vendored asic-rs crates =="
|
||||
python3 thirdparty/asic-rs/refresh-checksums.py --all
|
||||
echo "done."
|
||||
@@ -5,6 +5,7 @@
|
||||
# scripts/build-wx-linux.sh to produce it).
|
||||
set -e
|
||||
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
trap 'bash "$REPO/scripts/clean-old-builds.sh" || true' 0
|
||||
WX_PREFIX="${1:-$HOME/.cache/wx-3.3.3-linux}"
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
"$REPO/scripts/build-wx-linux.sh"
|
||||
|
||||
@@ -6,6 +6,21 @@ REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
SRC="$REPO/thirdparty/wxwidgets/wxWidgets-3.3.3"
|
||||
BUILD="$HOME/.cache/wxbuild/wxWidgets-3.3.3"
|
||||
PREFIX="$HOME/.cache/wx-3.3.3-linux"
|
||||
cleanup_wx_build() {
|
||||
python3 - "$BUILD" "$HOME/.cache/wxbuild" <<'PY'
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import sys
|
||||
|
||||
build, parent = map(Path, sys.argv[1:])
|
||||
if (build.name != "wxWidgets-3.3.3" or build.parent != parent
|
||||
or build.is_symlink() or parent.is_symlink()):
|
||||
raise SystemExit("refusing unsafe wxWidgets build cleanup path")
|
||||
if build.is_dir():
|
||||
shutil.rmtree(build)
|
||||
PY
|
||||
}
|
||||
trap cleanup_wx_build 0
|
||||
[ -d "$BUILD" ] || { mkdir -p "$HOME/.cache/wxbuild"; cp -r "$SRC" "$BUILD"; }
|
||||
[ -d "$BUILD" ] || { echo "thirdparty wxWidgets tree missing"; exit 1; }
|
||||
chmod +x "$BUILD/configure" "$BUILD/config.guess" "$BUILD/config.sub" "$BUILD/install-sh" 2>/dev/null || true
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Reclaim disk from the local cargo build directory.
|
||||
#
|
||||
# The app and the miner_probe CLI ship as release builds, and the unit tests run
|
||||
# under --release too (see the build notes), so the dev/debug profile tree, any
|
||||
# cross-compile target trees, and the coverage tree are all disposable: they only
|
||||
# ever reappear if something explicitly rebuilds them, and left alone they grow
|
||||
# without bound (a stray `cargo check`/`cargo test` can push the debug tree past
|
||||
# 30 GiB on its own). The release tree is kept warm so the next iteration is still
|
||||
# incremental; only its throwaway bits are pruned.
|
||||
#
|
||||
# Run it right after a release push -- the pushed commit is what CI builds and
|
||||
# ships, so the local intermediates are spare from that point. Safe to run any
|
||||
# time; it never deletes the release build itself.
|
||||
#
|
||||
# Honours CARGO_TARGET_DIR (the build sets it to ~/.cache/alkane-tk-target).
|
||||
set -uo pipefail
|
||||
|
||||
TARGET="${CARGO_TARGET_DIR:-$HOME/.cache/alkane-tk-target}"
|
||||
REPO="$(cd "$(dirname "$0")/.." && pwd)"
|
||||
case "$(realpath -m "$TARGET")" in
|
||||
"$HOME/.cache/alkane-tk-target"|"$REPO/target") ;;
|
||||
*) echo "clean-old-builds: refusing unexpected target $TARGET" >&2; exit 1 ;;
|
||||
esac
|
||||
if [ -L "$TARGET" ]; then
|
||||
echo "clean-old-builds: refusing symlink target $TARGET" >&2
|
||||
exit 1
|
||||
fi
|
||||
if [ ! -d "$TARGET" ]; then
|
||||
echo "clean-old-builds: no target dir at $TARGET (nothing to do)"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
human() { du -sh "$1" 2>/dev/null | cut -f1; }
|
||||
before=$(human "$TARGET")
|
||||
|
||||
# Disposable profile/aux trees -- regenerated on demand, never shipped.
|
||||
rm -rf "$TARGET"/debug "$TARGET"/llvm-cov-target "$TARGET"/doc 2>/dev/null
|
||||
|
||||
# Cross-compile target trees (e.g. armv7-unknown-linux-musleabihf). Rust target
|
||||
# triples all carry "-unknown-"; the host release/debug trees do not, so this
|
||||
# never touches the warm release build.
|
||||
for d in "$TARGET"/*-unknown-*; do
|
||||
[ -d "$d" ] && rm -rf "$d"
|
||||
done
|
||||
|
||||
# The incremental caches are rebuild accelerators, not build output -- dropping
|
||||
# them costs one slightly-slower rebuild and can free a few GiB.
|
||||
rm -rf "$TARGET"/release/incremental 2>/dev/null
|
||||
|
||||
# If cargo-sweep is installed, additionally drop release artifacts not touched in
|
||||
# the last few days (old dependency versions left by past rebuilds), keeping the
|
||||
# current build. Optional: install with `cargo install cargo-sweep`.
|
||||
if command -v cargo-sweep >/dev/null 2>&1; then
|
||||
cargo sweep --time 3 "$TARGET" >/dev/null 2>&1 || true
|
||||
fi
|
||||
|
||||
after=$(human "$TARGET")
|
||||
echo "clean-old-builds: $TARGET $before -> $after"
|
||||
@@ -8,13 +8,13 @@
|
||||
#
|
||||
# Usage: scripts/ui-screenshot.sh [out.png] [--live] [binary]
|
||||
set -u
|
||||
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
REPO=$(CDPATH='' cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
WX_PREFIX="${WX_PREFIX:-$HOME/.cache/wx-3.3.3-linux}"
|
||||
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$WX_PREFIX/bin/wx-config}"
|
||||
|
||||
OUT="${1:-alkane-toolkit.png}"
|
||||
LIVE=0; BIN=""
|
||||
shift 2>/dev/null || true
|
||||
[ "$#" -eq 0 ] || shift
|
||||
for a in "$@"; do
|
||||
case "$a" in
|
||||
--live) LIVE=1 ;;
|
||||
@@ -32,17 +32,31 @@ if [ -z "$BIN" ]; then
|
||||
fi
|
||||
[ -x "$BIN" ] || { echo "binary not found: $BIN" >&2; exit 3; }
|
||||
|
||||
DISP=":98"
|
||||
FAKE_ENV="ALKANE_FAKE_SCAN=1"
|
||||
[ "$LIVE" = "1" ] && FAKE_ENV=""
|
||||
|
||||
Xvfb "$DISP" -screen 0 1280x850x24 -nolisten tcp >/dev/null 2>&1 &
|
||||
DISPLAY_FILE=$(mktemp)
|
||||
XPID=""; APID=""; WARM=""
|
||||
cleanup() {
|
||||
[ -z "$APID" ] || kill "$APID" 2>/dev/null || true
|
||||
[ -z "$WARM" ] || kill "$WARM" 2>/dev/null || true
|
||||
[ -z "$XPID" ] || kill "$XPID" 2>/dev/null || true
|
||||
rm -f "$DISPLAY_FILE"
|
||||
}
|
||||
trap cleanup EXIT
|
||||
Xvfb -displayfd 3 -screen 0 1280x850x24 -nolisten tcp 3>"$DISPLAY_FILE" >/dev/null 2>&1 &
|
||||
XPID=$!
|
||||
sleep 1.2
|
||||
for _ in {1..30}; do
|
||||
[ -s "$DISPLAY_FILE" ] && break
|
||||
kill -0 "$XPID" 2>/dev/null || { echo "Xvfb exited before startup" >&2; exit 3; }
|
||||
sleep 0.1
|
||||
done
|
||||
[ -s "$DISPLAY_FILE" ] || { echo "Xvfb did not start" >&2; exit 3; }
|
||||
DISP=":$(cat "$DISPLAY_FILE")"
|
||||
# warm the font/GTK caches so the first window map is not stalled
|
||||
DISPLAY="$DISP" xclock >/dev/null 2>&1 & WARM=$!; sleep 1.2; kill "$WARM" 2>/dev/null
|
||||
# shellcheck disable=SC2086
|
||||
DISPLAY="$DISP" GDK_BACKEND=x11 $FAKE_ENV "$BIN" >/dev/null 2>&1 &
|
||||
if [ "$LIVE" = "1" ]; then
|
||||
DISPLAY="$DISP" GDK_BACKEND=x11 "$BIN" >/dev/null 2>&1 &
|
||||
else
|
||||
DISPLAY="$DISP" GDK_BACKEND=x11 ALKANE_FAKE_SCAN=1 "$BIN" >/dev/null 2>&1 &
|
||||
fi
|
||||
APID=$!
|
||||
WID=""; t=0
|
||||
while [ "$t" -lt 25 ]; do
|
||||
@@ -52,10 +66,6 @@ while [ "$t" -lt 25 ]; do
|
||||
[ -n "$line" ] && { WID=$(echo "$line" | awk '{print $1}'); break; }
|
||||
done
|
||||
sleep 2 # let it paint and drain a scan tick
|
||||
if [ -n "$WID" ]; then
|
||||
DISPLAY="$DISP" import -window "$WID" "$OUT" && echo "wrote $OUT (window $WID, ${t}s)"
|
||||
else
|
||||
DISPLAY="$DISP" import -window root "$OUT"; echo "no app window; captured root -> $OUT" >&2
|
||||
fi
|
||||
kill "$APID" 2>/dev/null
|
||||
kill "$XPID" 2>/dev/null
|
||||
[ -n "$WID" ] || { echo "no app window mapped" >&2; exit 1; }
|
||||
DISPLAY="$DISP" import -window "$WID" "$OUT" || exit 1
|
||||
echo "wrote $OUT (window $WID, ${t}s)"
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
upstream: asic-rs (crates.io)
|
||||
version: 0.8.1 (cargo-vendored under vendor/, per ADR 0003)
|
||||
state: pristine cargo-vendored tree + this patch queue.
|
||||
|
||||
asic-rs is materialized with `cargo vendor vendor` and consumed through
|
||||
.cargo/config.toml's vendored-sources replacement (directory = "vendor").
|
||||
Unlike wx-rs, asic-rs is many crates (asic-rs, asic-rs-core, and the
|
||||
per-make / per-firmware crates); a change to any of them lives here as a
|
||||
numbered .patch, NOT as an in-place edit of the pristine tree (ADR 0003).
|
||||
|
||||
The committed vendor/ tree already has the patches applied AND its affected
|
||||
crates' .cargo-checksum.json refreshed, so a normal build needs nothing extra
|
||||
-- the patch queue is provenance + the re-vendoring recipe.
|
||||
|
||||
GOTCHA (cargo caching): cargo fingerprints a registry/vendored crate by
|
||||
(name, version, source), NOT by file content, so it will REUSE a cached
|
||||
build of a vendored crate even after its source is edited. CI is unaffected
|
||||
(fresh target/ each run compiles the patched source). But an incremental
|
||||
LOCAL build that already compiled the unpatched crate must be forced:
|
||||
cargo clean -p asic-rs-firmwares-whatsminer # then rebuild
|
||||
Otherwise the local binary silently keeps the old behaviour.
|
||||
|
||||
Update / re-vendor flow:
|
||||
1. bump the pin in crates/alkane-gui/Cargo.toml, `cargo vendor vendor`
|
||||
(this regenerates a pristine vendor/ and DROPS our edits)
|
||||
2. scripts/apply-asic-rs-patches.sh # re-applies patches/ + refreshes checksums
|
||||
3. resolve any patch that no longer applies, rebuild, commit
|
||||
|
||||
patches/:
|
||||
0001 whatsminer set_power_limit (round-9 #4): fix the v3 (WhatsMinerOS)
|
||||
privileged auth -- the "super" account's token password is the separate
|
||||
v3 credential (default "super"), not the web/admin password -- and send
|
||||
the watts as a bare integer; also treat the apply-restart's transient
|
||||
RPC error as success. See the patch header.
|
||||
0002 antminer Equihash (Z15/Z15J) hashrate (round-10 #8): the cgminer "GHS"
|
||||
key carries a Sol/s value, so use the base Hash unit for Equihash so the
|
||||
SI prefix is correct ("288k", not "288T"). See the patch header.
|
||||
@@ -0,0 +1,104 @@
|
||||
Subject: [PATCH 0001] whatsminer set_power_limit: v3 auth/param fix + restart-tolerant result
|
||||
|
||||
Round-9 #4 -- "the power-limit on the WhatsMiners doesn't apply properly" --
|
||||
root-caused and verified against the live fleet.
|
||||
|
||||
v3 backend (WhatsMinerOS, firmware >= 2024-11-01, port 4433): the privileged
|
||||
power-limit write authenticated the "super" account with the WEB/admin password
|
||||
(a separate credential; the super account's factory default is "super") and sent
|
||||
the watts as a float, so the miner rejected every write with "invalid json or
|
||||
password is wrong". Fixes: v3 set_auth uses the super-account password ("super")
|
||||
-- the web password still drives the v2 (admin) path; set_power_limit sends a
|
||||
bare integer (a float trips the firmware's "invalid json" parser).
|
||||
|
||||
v2 backend (firmware < 2024-11-01, port 4028, "adjust_power_limit"): the command
|
||||
DOES apply the new watt limit, but the miner restarts to re-tune and drops the
|
||||
connection mid-command, so the read times out. Both v2 and v3 now treat a
|
||||
transient RPC error after the command (is_expected_write_error -- read timeout /
|
||||
connection reset, the same helper the pause/resume paths use) as success; a real
|
||||
rejection is a StatusCheckFailed and still errors.
|
||||
|
||||
Verified live: v3 (M30S+ fw 20241108) returns {"code":0,"msg":"ok"} and applies;
|
||||
v2 (M30S+ fw 20240930) applies the changed value (confirmed via the read-only
|
||||
:4028 "Power Limit" after the restart) and now returns Ok. All test miners were
|
||||
returned to their prior configured limit. Matches the pyasic / HashSource
|
||||
whatsminer-api-3 references.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs
|
||||
index c7b00e3b..096b2fcb 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/mod.rs
|
||||
@@ -637,11 +637,21 @@ impl SetFaultLight for WhatsMinerV2 {
|
||||
impl SetPowerLimit for WhatsMinerV2 {
|
||||
async fn set_power_limit(&self, limit: Power) -> anyhow::Result<bool> {
|
||||
let parameters = Some(json!({"power_limit": limit.as_watts().to_string()}));
|
||||
- let data = self
|
||||
+ match self
|
||||
.rpc
|
||||
.send_command("adjust_power_limit", true, parameters)
|
||||
- .await;
|
||||
- Ok(data.is_ok())
|
||||
+ .await
|
||||
+ {
|
||||
+ Ok(_) => Ok(true),
|
||||
+ // adjust_power_limit makes the miner restart to re-tune, so it drops
|
||||
+ // the connection / stops replying mid-command even though it accepted
|
||||
+ // and applied the new limit (verified on the live fleet: the set value
|
||||
+ // settles after the restart). A transient RPC error (read timeout /
|
||||
+ // connection reset) after the command is therefore success; a genuine
|
||||
+ // rejection surfaces as StatusCheckFailed and still errors.
|
||||
+ Err(e) if is_expected_write_error(&e) => Ok(true),
|
||||
+ Err(e) => Err(e),
|
||||
+ }
|
||||
}
|
||||
fn supports_set_power_limit(&self) -> bool {
|
||||
true
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v3/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v3/mod.rs
|
||||
index 77d724d5..c00c6d44 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v3/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v3/mod.rs
|
||||
@@ -669,12 +669,21 @@ impl SetFaultLight for WhatsMinerV3 {
|
||||
#[async_trait]
|
||||
impl SetPowerLimit for WhatsMinerV3 {
|
||||
async fn set_power_limit(&self, limit: Power) -> anyhow::Result<bool> {
|
||||
- let data = self
|
||||
+ // WhatsMinerOS wants a BARE INTEGER watt value; a float ("3000.0")
|
||||
+ // trips the firmware's "invalid json" parser (round-9 #4).
|
||||
+ let watts = limit.as_watts().round() as u64;
|
||||
+ match self
|
||||
.rpc
|
||||
- .send_command("set.miner.power_limit", true, Some(json!(limit.as_watts())))
|
||||
- .await;
|
||||
-
|
||||
- Ok(data.is_ok())
|
||||
+ .send_command("set.miner.power_limit", true, Some(json!(watts)))
|
||||
+ .await
|
||||
+ {
|
||||
+ Ok(_) => Ok(true),
|
||||
+ // A power-limit change restarts the miner to re-tune, so a transient
|
||||
+ // RPC error after the command means it was accepted (as with v2), not
|
||||
+ // rejected; a genuine rejection is a StatusCheckFailed and still errors.
|
||||
+ Err(e) if is_expected_write_error(&e) => Ok(true),
|
||||
+ Err(e) => Err(e),
|
||||
+ }
|
||||
}
|
||||
fn supports_set_power_limit(&self) -> bool {
|
||||
true
|
||||
@@ -806,8 +815,15 @@ impl HasDefaultAuth for WhatsMinerV3 {
|
||||
|
||||
impl HasAuth for WhatsMinerV3 {
|
||||
fn set_auth(&mut self, auth: MinerAuth) {
|
||||
- // WhatsMiner V3 username is always "super", V2 is always "admin"
|
||||
- self.rpc.set_auth(MinerAuth::new("super", auth.password()));
|
||||
+ // WhatsMiner V3 username is always "super", V2 is always "admin".
|
||||
+ // The V3 privileged token authenticates against the "super" ACCOUNT,
|
||||
+ // whose password is a separate v3 credential (factory default "super")
|
||||
+ // -- NOT the web/admin password carried by `auth`. Pairing account
|
||||
+ // "super" with the web password made every v3 privileged write fail with
|
||||
+ // "invalid json or password is wrong" (round-9 #4, confirmed on the live
|
||||
+ // fleet). Keep the super-account default password here; the web password
|
||||
+ // still drives the v2 (admin) path below.
|
||||
+ self.rpc.set_auth(MinerAuth::new("super", "super"));
|
||||
self.v2_rpc
|
||||
.set_auth(MinerAuth::new("admin", auth.password()));
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
Subject: [PATCH 0002] antminer: Equihash (Z15/Z15J) hashrate uses base Sol/s unit
|
||||
|
||||
Round-10 #8 -- a Z15 shows its hashrate in 'T' (e.g. "288T") when it should be
|
||||
'k' (~288 kSol/s). Root cause verified on the live fleet: Equihash miners report
|
||||
a Sol/s rate in the cgminer "GHS" key, but AntMiner's parse_hashrate takes the
|
||||
unit from the key name ("GHS" -> GigaHash), scaling the value 1e9x too large.
|
||||
The value is a raw Sol/s count, so for Equihash use the base Hash unit; the
|
||||
downstream SI-prefixing then yields "288k". Matched by algorithm, and by "Z15"
|
||||
model name for the Z15J which asic-rs leaves algo Unknown. Applies to both the
|
||||
v2020 and v2023_07 backends. Verified: Z15 288T -> 288k, Z15J 138T -> 110k.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
index cd4f7cbd..5b9f77b3 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
@@ -14,7 +14,7 @@ use asic_rs_core::{
|
||||
DataCollector, DataExtensions, DataExtractor, DataField, DataLocation, get_by_pointer,
|
||||
},
|
||||
command::MinerCommand,
|
||||
- device::DeviceInfo,
|
||||
+ device::{DeviceInfo, HashAlgorithm},
|
||||
fan::FanData,
|
||||
firmware::FirmwareImage,
|
||||
hashrate::{HashRate, HashRateUnit},
|
||||
@@ -722,6 +722,15 @@ impl GetHashrate for AntMinerV2020 {
|
||||
})
|
||||
})?;
|
||||
|
||||
+ // Equihash miners (e.g. Z15/Z15J) report a Sol/s rate in the cgminer
|
||||
+ // "GHS" key, so the key's GigaHash label is wrong -- the value is the
|
||||
+ // raw Sol/s count. Use the base unit so the magnitude (and SI prefix)
|
||||
+ // is correct (e.g. ~288000 Sol/s -> "288k", not "288T"). Match by algo,
|
||||
+ // and by Z15 model name for the Z15J which asic-rs leaves algo Unknown.
|
||||
+ let is_equihash = self.device_info.algo == HashAlgorithm::Equihash
|
||||
+ || self.device_info.model.to_string().to_ascii_uppercase().contains("Z15");
|
||||
+ let unit = if is_equihash { HashRateUnit::Hash } else { unit };
|
||||
+
|
||||
Some(
|
||||
HashRate {
|
||||
value,
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2023_07/mod.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2023_07/mod.rs
|
||||
index 4ba13537..6d6dc593 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2023_07/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2023_07/mod.rs
|
||||
@@ -16,7 +16,7 @@ use asic_rs_core::{
|
||||
DataCollector, DataExtensions, DataExtractor, DataField, DataLocation, get_by_pointer,
|
||||
},
|
||||
command::MinerCommand,
|
||||
- device::DeviceInfo,
|
||||
+ device::{DeviceInfo, HashAlgorithm},
|
||||
fan::FanData,
|
||||
firmware::FirmwareImage,
|
||||
hashrate::{HashRate, HashRateUnit},
|
||||
@@ -698,6 +698,15 @@ impl GetHashrate for AntMinerV202307 {
|
||||
})
|
||||
})?;
|
||||
|
||||
+ // Equihash miners (e.g. Z15/Z15J) report a Sol/s rate in the cgminer
|
||||
+ // "GHS" key, so the key's GigaHash label is wrong -- the value is the
|
||||
+ // raw Sol/s count. Use the base unit so the magnitude (and SI prefix)
|
||||
+ // is correct (e.g. ~288000 Sol/s -> "288k", not "288T"). Match by algo,
|
||||
+ // and by Z15 model name for the Z15J which asic-rs leaves algo Unknown.
|
||||
+ let is_equihash = self.device_info.algo == HashAlgorithm::Equihash
|
||||
+ || self.device_info.model.to_string().to_ascii_uppercase().contains("Z15");
|
||||
+ let unit = if is_equihash { HashRateUnit::Hash } else { unit };
|
||||
+
|
||||
Some(
|
||||
HashRate {
|
||||
value,
|
||||
@@ -0,0 +1,29 @@
|
||||
Subject: [PATCH 0003] antminer: recognise VNish short control-board platforms (CV, XIL)
|
||||
|
||||
Round-11 #5 -- VNish reports the control board in short form via /api/v1/info
|
||||
"platform": "cv" (CVITek), "xil" (Xilinx), "aml" (AMLogic). asic-rs's
|
||||
AntMinerControlBoard::parse matched the full names (CVITEK, XILINX) but not the
|
||||
short "CV"/"XIL", so VNish CVITek and Xilinx boards showed a blank control board
|
||||
(the "can't scan XIL or CVITek boards" bug). Add the short forms. Verified live:
|
||||
S19k Pro platform "cv" -> CVITek, S19 platform "xil" -> Xilinx.
|
||||
|
||||
diff --git a/vendor/asic-rs-makes-antminer/src/hardware.rs b/vendor/asic-rs-makes-antminer/src/hardware.rs
|
||||
index 41a73240..aa0923c8 100644
|
||||
--- a/vendor/asic-rs-makes-antminer/src/hardware.rs
|
||||
+++ b/vendor/asic-rs-makes-antminer/src/hardware.rs
|
||||
@@ -268,11 +268,13 @@ impl AntMinerControlBoard {
|
||||
.collect::<String>();
|
||||
|
||||
match compact.as_str() {
|
||||
- "XILINX" => Some(Self::Xilinx),
|
||||
+ // "XIL" is VNish's short platform form for a Xilinx control board.
|
||||
+ "XILINX" | "XIL" => Some(Self::Xilinx),
|
||||
"BBB" | "BBCTRL" | "BB" | "BEAGLEBONE" | "BEAGLEBONEBLACK" => {
|
||||
Some(Self::BeagleBoneBlack)
|
||||
}
|
||||
- "CVITEK" | "CVCTRL" => Some(Self::CVITek),
|
||||
+ // "CV" is VNish's short platform form for a CVITek control board.
|
||||
+ "CVITEK" | "CVCTRL" | "CV" => Some(Self::CVITek),
|
||||
"AMLOGIC" | "AML" => Some(Self::AMLogic),
|
||||
"AMCB07" => Some(Self::Xilinx), // Mara FW
|
||||
"ZYNQ7007" => Some(Self::Xilinx),
|
||||
@@ -0,0 +1,65 @@
|
||||
Subject: [PATCH 0004] whatsminer v1: control-board fallback + optional ALLWINNER_ prefix
|
||||
|
||||
Round-11 #5 -- older M30S firmware (< 2022.7.29, the v1 backend) often omits
|
||||
"CB Platform" from the summary RPC, and its parse mandatorily stripped an
|
||||
"ALLWINNER_" prefix (strip_prefix(..)? -> None when absent), so those units
|
||||
showed a blank control board. Add get_version /Msg/platform (the source v2 uses)
|
||||
as a fallback location, and make the ALLWINNER_ strip optional. Verified live:
|
||||
M30S+ VE40 (fw 20220422, v1) blank -> H6OS.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
index b4a27db8..f95a22ae 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
@@ -131,14 +131,28 @@ impl GetDataLocations for WhatsMinerV1 {
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
- DataField::ControlBoardVersion => vec![(
|
||||
- RPC_SUMMARY,
|
||||
- DataExtractor {
|
||||
- func: get_by_pointer,
|
||||
- key: Some("/SUMMARY/0/CB Platform"),
|
||||
- tag: None,
|
||||
- },
|
||||
- )],
|
||||
+ DataField::ControlBoardVersion => vec![
|
||||
+ (
|
||||
+ RPC_SUMMARY,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/SUMMARY/0/CB Platform"),
|
||||
+ tag: None,
|
||||
+ },
|
||||
+ ),
|
||||
+ // Older M30S firmware (< 2022.7.29, so this v1 backend) often omits
|
||||
+ // "CB Platform" from summary but still reports the board under
|
||||
+ // get_version /Msg/platform (the source v2 uses). Fall back to it so
|
||||
+ // those units don't show a blank control board.
|
||||
+ (
|
||||
+ RPC_GET_VERSION,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/Msg/platform"),
|
||||
+ tag: None,
|
||||
+ },
|
||||
+ ),
|
||||
+ ],
|
||||
DataField::TuningTarget => vec![(
|
||||
RPC_SUMMARY,
|
||||
DataExtractor {
|
||||
@@ -285,8 +299,12 @@ impl GetControlBoardVersion for WhatsMinerV1 {
|
||||
) -> Option<MinerControlBoard> {
|
||||
data.extract::<String>(DataField::ControlBoardVersion)
|
||||
.and_then(|s| {
|
||||
- WhatsMinerControlBoard::parse(s.to_uppercase().strip_prefix("ALLWINNER_")?)
|
||||
- .map(|cb| cb.into())
|
||||
+ // The "ALLWINNER_" prefix is optional: summary's CB Platform carries
|
||||
+ // it (e.g. "ALLWINNER_H6"), but the get_version /Msg/platform fallback
|
||||
+ // does not (e.g. "H6OS"). Strip it only when present.
|
||||
+ let up = s.to_uppercase();
|
||||
+ let board = up.strip_prefix("ALLWINNER_").unwrap_or(&up);
|
||||
+ WhatsMinerControlBoard::parse(board).map(|cb| cb.into())
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
Subject: [PATCH 0005] vnish: surface the partner build name in the firmware version
|
||||
|
||||
Round-11 #6b/#11 -- VNish /api/v1/info carries a partner/reseller "build_name"
|
||||
("WildRose", "vnishreturn", ...) alongside "fw_version"; it is shown in the
|
||||
Hashcore toolkit but asic-rs did not expose it. Point the FirmwareVersion
|
||||
extractor at /build_name and combine it with the /fw_version number (still on
|
||||
ApiVersion) in parse_firmware_version, so firmware_version reads "<build>
|
||||
<version>", e.g. "WildRose 1.2.7". Applies to both the v1_2_0 and v1_3_0
|
||||
backends. Verified live: S19j Pro -> "WildRose 1.2.7", S19k Pro -> "vnishreturn 1.3.5".
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs b/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs
|
||||
index 4cc1434a..e734a03e 100644
|
||||
--- a/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-vnish/src/backends/v1_2_0/mod.rs
|
||||
@@ -179,11 +179,15 @@ impl GetDataLocations for VnishV120 {
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
+ // The partner/reseller build name ("WildRose", "vnishreturn", ...) --
|
||||
+ // combined with the version number in parse_firmware_version so the FW
|
||||
+ // Version column shows e.g. "WildRose 1.3.5". ApiVersion still carries
|
||||
+ // the bare /fw_version.
|
||||
DataField::FirmwareVersion => vec![(
|
||||
WEB_INFO,
|
||||
DataExtractor {
|
||||
func: get_by_pointer,
|
||||
- key: Some("/fw_version"),
|
||||
+ key: Some("/build_name"),
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
@@ -415,7 +419,20 @@ impl GetApiVersion for VnishV120 {
|
||||
|
||||
impl GetFirmwareVersion for VnishV120 {
|
||||
fn parse_firmware_version(&self, data: &HashMap<DataField, Value>) -> Option<String> {
|
||||
- data.extract::<String>(DataField::FirmwareVersion)
|
||||
+ // FirmwareVersion carries /build_name (the partner build), ApiVersion the
|
||||
+ // /fw_version number; show "<build> <version>" when both are present, else
|
||||
+ // whichever is available.
|
||||
+ let build = data
|
||||
+ .extract::<String>(DataField::FirmwareVersion)
|
||||
+ .filter(|b| !b.is_empty());
|
||||
+ let version = data
|
||||
+ .extract::<String>(DataField::ApiVersion)
|
||||
+ .filter(|v| !v.is_empty());
|
||||
+ match (build, version) {
|
||||
+ (Some(b), Some(v)) => Some(format!("{b} {v}")),
|
||||
+ (Some(b), None) => Some(b),
|
||||
+ (None, v) => v,
|
||||
+ }
|
||||
}
|
||||
}
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs b/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs
|
||||
index 6975d9e5..0a5d694e 100644
|
||||
--- a/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-vnish/src/backends/v1_3_0/mod.rs
|
||||
@@ -179,11 +179,13 @@ impl GetDataLocations for VnishV130 {
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
+ // Partner/reseller build name; combined with the version number in
|
||||
+ // parse_firmware_version (FW Version shows e.g. "WildRose 1.3.5").
|
||||
DataField::FirmwareVersion => vec![(
|
||||
WEB_INFO,
|
||||
DataExtractor {
|
||||
func: get_by_pointer,
|
||||
- key: Some("/fw_version"),
|
||||
+ key: Some("/build_name"),
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
@@ -423,7 +425,19 @@ impl GetApiVersion for VnishV130 {
|
||||
|
||||
impl GetFirmwareVersion for VnishV130 {
|
||||
fn parse_firmware_version(&self, data: &HashMap<DataField, Value>) -> Option<String> {
|
||||
- data.extract::<String>(DataField::FirmwareVersion)
|
||||
+ // FirmwareVersion carries /build_name (partner build), ApiVersion the
|
||||
+ // /fw_version number; show "<build> <version>" when both are present.
|
||||
+ let build = data
|
||||
+ .extract::<String>(DataField::FirmwareVersion)
|
||||
+ .filter(|b| !b.is_empty());
|
||||
+ let version = data
|
||||
+ .extract::<String>(DataField::ApiVersion)
|
||||
+ .filter(|v| !v.is_empty());
|
||||
+ match (build, version) {
|
||||
+ (Some(b), Some(v)) => Some(format!("{b} {v}")),
|
||||
+ (Some(b), None) => Some(b),
|
||||
+ (None, v) => v,
|
||||
+ }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,243 @@
|
||||
Subject: [PATCH 0006] antminer: route old models to the right backend + read the Z15 control board
|
||||
|
||||
Round-12 #10. Three fixes for stock Antminer Z15/Z15J (fw 2020), all verified
|
||||
live on 10.5.1.x:
|
||||
|
||||
1. Backend routing: the version detector only read summary.cgi, which older
|
||||
models (Z15) do not serve (404) -> version None -> AntMiner::new defaulted to
|
||||
the newest backend, which mis-parsed the miner (empty control board, no
|
||||
expected hashrate/wattage/fans). Fall back to the cgminer :4028 `version`
|
||||
RPC's CompileTime so the Z15 (2020) routes to the v2020 backend.
|
||||
|
||||
2. Control board "read, not guess": the Z15 has no miner_type.cgi, so its
|
||||
control-board subtype is unreadable there. Read the kernel build string from
|
||||
get_system_info.cgi instead ("Linux 4.6.0-xilinx-..." -> Xilinx); the
|
||||
ControlBoardVersion field now carries both the subtype and the kernel, and the
|
||||
parser prefers the subtype and falls back to the kernel marker.
|
||||
|
||||
3. Malformed cgminer stats: the Z15 emits a stats array whose objects are not
|
||||
comma-separated (`...}{"STATS":0...`), invalid JSON that serde rejected,
|
||||
dropping the whole stats command and every stats-derived field. Insert the
|
||||
missing separators before parsing (a no-op on well-formed responses); this
|
||||
restores expected hashrate, fans, hashboards and uptime. The expected
|
||||
hashrate also gets the same Equihash Sol/s reinterpretation as the realtime
|
||||
rate, so both read on one scale (e.g. 144k / 320k) instead of the expected
|
||||
reading ~1e6x larger.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
index 5b9f77b3..a02bdf9d 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
@@ -434,14 +434,29 @@ impl GetDataLocations for AntMinerV2020 {
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
- DataField::ControlBoardVersion => vec![(
|
||||
- WEB_MINER_TYPE,
|
||||
- DataExtractor {
|
||||
- func: get_by_pointer,
|
||||
- key: Some("/subtype"),
|
||||
- tag: None,
|
||||
- },
|
||||
- )],
|
||||
+ // Prefer the explicit control-board subtype from miner_type.cgi, but
|
||||
+ // carry the kernel build string from get_system_info.cgi too: older
|
||||
+ // models (e.g. Z15/Z15J) have no miner_type.cgi, and their kernel
|
||||
+ // string ("...-xilinx-...") names the control board we can actually
|
||||
+ // read instead of guessing from the model (round 12 #10).
|
||||
+ DataField::ControlBoardVersion => vec![
|
||||
+ (
|
||||
+ WEB_MINER_TYPE,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/subtype"),
|
||||
+ tag: Some("subtype"),
|
||||
+ },
|
||||
+ ),
|
||||
+ (
|
||||
+ WEB_SYSTEM_INFO,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/system_kernel_version"),
|
||||
+ tag: Some("kernel"),
|
||||
+ },
|
||||
+ ),
|
||||
+ ],
|
||||
// cgminer names its summary keys after the unit they are in —
|
||||
// `GHS 5s` on SHA-256 models, `MHS 5s` on Scrypt ones — so keep
|
||||
// the whole entry and let the parse pick the key that is present.
|
||||
@@ -748,16 +763,33 @@ impl GetExpectedHashrate for AntMinerV2020 {
|
||||
let value = field?
|
||||
.pointer("/hashrate")
|
||||
.and_then(Self::parse_f64_field)?;
|
||||
+ // Equihash miners (Z15/Z15J) report `total_rateideal` as a Sol/s count in
|
||||
+ // the same (mislabelled) scale as the realtime "GHS" rate, so reinterpret
|
||||
+ // it as the base Hash unit -- matching parse_hashrate. Without this,
|
||||
+ // expected reads ~1e6x larger than realtime and the realtime figure looks
|
||||
+ // absent next to it (round 12 #10).
|
||||
+ let is_equihash = self.device_info.algo == HashAlgorithm::Equihash
|
||||
+ || self
|
||||
+ .device_info
|
||||
+ .model
|
||||
+ .to_string()
|
||||
+ .to_ascii_uppercase()
|
||||
+ .contains("Z15");
|
||||
+ let unit = if is_equihash {
|
||||
+ HashRateUnit::Hash
|
||||
+ } else {
|
||||
+ // `total_rateideal` does not name its own scale, so take it from
|
||||
+ // STATS' `rate_unit` (`"GH"` / `"MH"`).
|
||||
+ field
|
||||
+ .and_then(|v| v.pointer("/unit"))
|
||||
+ .and_then(|v| v.as_str())
|
||||
+ .and_then(|s| HashRateUnit::from_str(s).ok())
|
||||
+ .unwrap_or(HashRateUnit::GigaHash)
|
||||
+ };
|
||||
Some(
|
||||
HashRate {
|
||||
value,
|
||||
- // `total_rateideal` does not name its own scale, so take it
|
||||
- // from STATS' `rate_unit` (`"GH"` / `"MH"`).
|
||||
- unit: field
|
||||
- .and_then(|v| v.pointer("/unit"))
|
||||
- .and_then(|v| v.as_str())
|
||||
- .and_then(|s| HashRateUnit::from_str(s).ok())
|
||||
- .unwrap_or(HashRateUnit::GigaHash),
|
||||
+ unit,
|
||||
algo: self.device_info.algo,
|
||||
}
|
||||
.as_unit(HashRateUnit::default()),
|
||||
@@ -888,11 +920,34 @@ impl GetControlBoardVersion for AntMinerV2020 {
|
||||
&self,
|
||||
data: &HashMap<DataField, Value>,
|
||||
) -> Option<MinerControlBoard> {
|
||||
- let cb_type = data.extract::<String>(DataField::ControlBoardVersion)?;
|
||||
- match cb_type.as_str() {
|
||||
- s if s.to_uppercase().contains("AML") => Some(AntMinerControlBoard::AMLogic.into()),
|
||||
- _ => AntMinerControlBoard::parse(cb_type.split("_").collect::<Vec<&str>>()[0])
|
||||
- .map(|cb| cb.into()),
|
||||
+ let field = data.get(&DataField::ControlBoardVersion)?;
|
||||
+ // Explicit control-board subtype (miner_type.cgi) wins when present.
|
||||
+ let subtype = field
|
||||
+ .pointer("/subtype")
|
||||
+ .and_then(|v| v.as_str())
|
||||
+ .unwrap_or("");
|
||||
+ if !subtype.is_empty() {
|
||||
+ return match subtype {
|
||||
+ s if s.to_uppercase().contains("AML") => Some(AntMinerControlBoard::AMLogic.into()),
|
||||
+ _ => AntMinerControlBoard::parse(subtype.split('_').next().unwrap_or(subtype))
|
||||
+ .map(|cb| cb.into()),
|
||||
+ };
|
||||
+ }
|
||||
+ // No subtype (older models): read the control board from the kernel build
|
||||
+ // string instead of guessing from the model (round 12 #10). Bitmain names
|
||||
+ // the SoC in the kernel version, e.g. "Linux 4.6.0-xilinx-..." (Z15) or an
|
||||
+ // AMLogic/Meson kernel on newer AMLogic boards.
|
||||
+ let kernel = field
|
||||
+ .pointer("/kernel")
|
||||
+ .and_then(|v| v.as_str())
|
||||
+ .unwrap_or("")
|
||||
+ .to_ascii_lowercase();
|
||||
+ if kernel.contains("xilinx") || kernel.contains("zynq") {
|
||||
+ Some(AntMinerControlBoard::Xilinx.into())
|
||||
+ } else if kernel.contains("aml") || kernel.contains("meson") {
|
||||
+ Some(AntMinerControlBoard::AMLogic.into())
|
||||
+ } else {
|
||||
+ None
|
||||
}
|
||||
}
|
||||
}
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/rpc.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/rpc.rs
|
||||
index 23962f35..52232c1f 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/rpc.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/rpc.rs
|
||||
@@ -71,7 +71,17 @@ impl AntMinerRPCAPI {
|
||||
read_stream_response(&mut stream, DEFAULT_RPC_TIMEOUT).await
|
||||
};
|
||||
let response = response?;
|
||||
- self.parse_rpc_result(&response)
|
||||
+ self.parse_rpc_result(&Self::sanitize_cgminer(&response))
|
||||
+ }
|
||||
+
|
||||
+ /// Antminer's cgminer `stats` sometimes emits an array whose objects are not
|
||||
+ /// comma-separated (`...}{"STATS":0,...` on the Z15/Z15J), which is invalid
|
||||
+ /// JSON that serde rejects -- dropping the whole stats command and with it
|
||||
+ /// every stats-derived field (expected hashrate, wattage, fans, hashboards,
|
||||
+ /// uptime). Insert the missing separators. Well-formed JSON never contains an
|
||||
+ /// unseparated `}{`, so this is a no-op on valid responses (round 12 #10).
|
||||
+ fn sanitize_cgminer(response: &str) -> String {
|
||||
+ response.replace("}{", "},{")
|
||||
}
|
||||
|
||||
fn parse_rpc_result(&self, response: &str) -> anyhow::Result<Value> {
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/firmware.rs b/vendor/asic-rs-firmwares-antminer/src/firmware.rs
|
||||
index fce5e8ff..46abbc9d 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/firmware.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/firmware.rs
|
||||
@@ -142,18 +142,9 @@ async fn get_model_with_auth(
|
||||
}
|
||||
}
|
||||
|
||||
-/// Fetch the firmware version from a miner using digest auth.
|
||||
-async fn get_version_with_auth(ip: IpAddr, auth: &MinerAuth) -> Option<semver::Version> {
|
||||
- let client = build_discovery_client().ok()?;
|
||||
- let data: Response = client
|
||||
- .get(format!("http://{ip}/cgi-bin/summary.cgi"))
|
||||
- .send_digest_auth((auth.username(), auth.password()))
|
||||
- .await
|
||||
- .ok()?;
|
||||
-
|
||||
- let json_data = data.json::<serde_json::Value>().await.ok()?;
|
||||
- let fw_version = json_data["INFO"]["CompileTime"].as_str().unwrap_or("");
|
||||
-
|
||||
+/// Parse an Antminer cgminer `CompileTime` string ("Mon Dec 14 18:01:42 CST
|
||||
+/// 2020") into a date-based semver (year.month.day) used to pick the backend.
|
||||
+fn parse_antminer_compile_time(fw_version: &str) -> Option<semver::Version> {
|
||||
let cleaned: String = {
|
||||
let mut parts: Vec<&str> = fw_version.split_whitespace().collect();
|
||||
if parts.len() > 4 {
|
||||
@@ -161,9 +152,7 @@ async fn get_version_with_auth(ip: IpAddr, auth: &MinerAuth) -> Option<semver::V
|
||||
}
|
||||
parts.join(" ")
|
||||
};
|
||||
-
|
||||
let dt = NaiveDateTime::parse_from_str(&cleaned, "%a %b %e %H:%M:%S %Y").ok()?;
|
||||
-
|
||||
Some(semver::Version::new(
|
||||
dt.year() as u64,
|
||||
dt.month() as u64,
|
||||
@@ -171,6 +160,34 @@ async fn get_version_with_auth(ip: IpAddr, auth: &MinerAuth) -> Option<semver::V
|
||||
))
|
||||
}
|
||||
|
||||
+/// Fetch the firmware version (as a date-based semver) to pick the backend.
|
||||
+async fn get_version_with_auth(ip: IpAddr, auth: &MinerAuth) -> Option<semver::Version> {
|
||||
+ // Newer Antminers expose the firmware CompileTime via summary.cgi.
|
||||
+ if let Ok(client) = build_discovery_client()
|
||||
+ && let Ok(data) = client
|
||||
+ .get(format!("http://{ip}/cgi-bin/summary.cgi"))
|
||||
+ .send_digest_auth((auth.username(), auth.password()))
|
||||
+ .await
|
||||
+ && let Ok(json_data) = data.json::<serde_json::Value>().await
|
||||
+ && let Some(v) =
|
||||
+ parse_antminer_compile_time(json_data["INFO"]["CompileTime"].as_str().unwrap_or(""))
|
||||
+ {
|
||||
+ return Some(v);
|
||||
+ }
|
||||
+
|
||||
+ // Older models (e.g. Z15/Z15J) have no summary.cgi, so summary-based version
|
||||
+ // detection returns nothing and the miner would default to the newest
|
||||
+ // backend and be mis-parsed. Fall back to the cgminer :4028 `version` RPC,
|
||||
+ // which still reports the CompileTime, so the right (older) backend is picked
|
||||
+ // (round 12 #10).
|
||||
+ let rpc = asic_rs_core::util::send_rpc_command(&ip, "version").await?;
|
||||
+ parse_antminer_compile_time(
|
||||
+ rpc.pointer("/VERSION/0/CompileTime")
|
||||
+ .and_then(|v| v.as_str())
|
||||
+ .unwrap_or(""),
|
||||
+ )
|
||||
+}
|
||||
+
|
||||
#[async_trait]
|
||||
impl MinerFirmware for AntMinerStockFirmware {
|
||||
/// Uses default credentials. For custom credentials, use `build_miner`
|
||||
@@ -0,0 +1,205 @@
|
||||
Subject: [PATCH 0007] whatsminer: enable control commands on the V1 backend
|
||||
|
||||
Round-12 #8b part 2. Pre-2022-07-29 WhatsMiners route to the V1 backend, which
|
||||
exposed no control commands (every supports_* returned false), so older units
|
||||
could be monitored but not controlled -- and the GUI's capability-based actions
|
||||
never lit up for them. V1-era firmware speaks the same classic btminer token
|
||||
write API (get_token + md5crypt + AES-256-ECB) as V2 (the access-probe token
|
||||
handshake proved V1 accepts it), so V1 now reuses V2's proven RPC client for
|
||||
writes: set_fault_light, set_power_limit, update_pools, restart, pause, resume
|
||||
are implemented exactly as V2, going through a new `write_rpc`
|
||||
(crate::backends::v2::rpc), and HasAuth routes the admin password to it.
|
||||
|
||||
Verified on a live V1 unit that the token AES key (password) is accepted; the
|
||||
control-command write path is identical to V2's, which is validated live on the
|
||||
fleet. Note: some V1 units keep their API in read-only mode and answer write
|
||||
commands with Code 45 "can't access write cmd" until an operator enables write
|
||||
access via the WhatsMiner Tool -- that is a per-device setting, and the backend
|
||||
now fails such a write gracefully rather than not offering the command at all.
|
||||
The 40 whatsminer crate tests pass unchanged.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
index f95a22ae..c9c96713 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
@@ -26,8 +26,9 @@ use async_trait::async_trait;
|
||||
use macaddr::MacAddr;
|
||||
use measurements::{AngularVelocity, Frequency, Power, Temperature};
|
||||
use rpc::WhatsMinerRPCAPI;
|
||||
+use asic_rs_core::util::is_expected_write_error;
|
||||
use semver::Version;
|
||||
-use serde_json::Value;
|
||||
+use serde_json::{Value, json};
|
||||
|
||||
use crate::firmware::WhatsMinerFirmware;
|
||||
|
||||
@@ -37,6 +38,12 @@ mod rpc;
|
||||
pub struct WhatsMinerV1 {
|
||||
pub ip: IpAddr,
|
||||
pub rpc: WhatsMinerRPCAPI,
|
||||
+ // Privileged (token-authenticated) writes reuse the V2 btminer RPC client:
|
||||
+ // pre-2022-07-29 miners speak the same classic get_token + AES-ECB write API
|
||||
+ // as V2 (proven live via the access-probe token handshake), so the control
|
||||
+ // commands share V2's implementation instead of the read-only V1 rpc above
|
||||
+ // (round 12 #8b part 2).
|
||||
+ pub write_rpc: crate::backends::v2::rpc::WhatsMinerRPCAPI,
|
||||
pub device_info: DeviceInfo,
|
||||
}
|
||||
|
||||
@@ -45,6 +52,11 @@ impl WhatsMinerV1 {
|
||||
WhatsMinerV1 {
|
||||
ip,
|
||||
rpc: WhatsMinerRPCAPI::new(ip, None),
|
||||
+ write_rpc: crate::backends::v2::rpc::WhatsMinerRPCAPI::new(
|
||||
+ ip,
|
||||
+ None,
|
||||
+ MinerAuth::new("admin", "admin"),
|
||||
+ ),
|
||||
device_info: DeviceInfo::new(
|
||||
model,
|
||||
WhatsMinerFirmware::default(),
|
||||
@@ -560,17 +572,45 @@ impl GetPools for WhatsMinerV1 {
|
||||
}
|
||||
}
|
||||
|
||||
+#[async_trait]
|
||||
+// Control commands (round 12 #8b part 2): the classic btminer token write API is
|
||||
+// the same on V1-era firmware as on V2, so these mirror the V2 backend but go
|
||||
+// through `write_rpc`. The write path was validated live on a V1 unit with the
|
||||
+// reversible locate-light command (safe, non-disruptive to mining).
|
||||
#[async_trait]
|
||||
impl SetFaultLight for WhatsMinerV1 {
|
||||
+ async fn set_fault_light(&self, fault: bool) -> anyhow::Result<bool> {
|
||||
+ let parameters = match fault {
|
||||
+ false => Some(json!({"param": "auto"})),
|
||||
+ true => Some(json!({"color": "red", "period": 200, "duration": 100, "start": 0})),
|
||||
+ };
|
||||
+ let data = self.write_rpc.send_command("set_led", true, parameters).await;
|
||||
+ Ok(data.is_ok())
|
||||
+ }
|
||||
fn supports_set_fault_light(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl SetPowerLimit for WhatsMinerV1 {
|
||||
+ async fn set_power_limit(&self, limit: Power) -> anyhow::Result<bool> {
|
||||
+ let parameters = Some(json!({"power_limit": limit.as_watts().to_string()}));
|
||||
+ match self
|
||||
+ .write_rpc
|
||||
+ .send_command("adjust_power_limit", true, parameters)
|
||||
+ .await
|
||||
+ {
|
||||
+ Ok(_) => Ok(true),
|
||||
+ // adjust_power_limit restarts the miner to re-tune, dropping the
|
||||
+ // connection mid-command even though the limit was accepted; a
|
||||
+ // transient write error is success, a genuine rejection still errors.
|
||||
+ Err(e) if is_expected_write_error(&e) => Ok(true),
|
||||
+ Err(e) => Err(e),
|
||||
+ }
|
||||
+ }
|
||||
fn supports_set_power_limit(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -585,29 +625,77 @@ impl SupportsPoolsConfig for WhatsMinerV1 {
|
||||
.collect())
|
||||
}
|
||||
|
||||
+ async fn set_pools_config(&self, config: Vec<PoolGroupConfig>) -> anyhow::Result<bool> {
|
||||
+ let group = config
|
||||
+ .into_iter()
|
||||
+ .next()
|
||||
+ .ok_or_else(|| anyhow::anyhow!("No pool groups provided"))?;
|
||||
+ let mut params = serde_json::Map::new();
|
||||
+ for n in 1..=3 {
|
||||
+ let pool = group.pools.get(n - 1);
|
||||
+ params.insert(
|
||||
+ format!("pool{n}"),
|
||||
+ json!(pool.map(|p| p.url.to_string()).unwrap_or_default()),
|
||||
+ );
|
||||
+ params.insert(
|
||||
+ format!("worker{n}"),
|
||||
+ json!(pool.map(|p| p.username.as_str()).unwrap_or_default()),
|
||||
+ );
|
||||
+ params.insert(
|
||||
+ format!("passwd{n}"),
|
||||
+ json!(pool.map(|p| p.password.as_str()).unwrap_or_default()),
|
||||
+ );
|
||||
+ }
|
||||
+ Ok(self
|
||||
+ .write_rpc
|
||||
+ .send_command("update_pools", true, Some(json!(params)))
|
||||
+ .await
|
||||
+ .is_ok())
|
||||
+ }
|
||||
+
|
||||
fn supports_pools_config(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Restart for WhatsMinerV1 {
|
||||
+ async fn restart(&self) -> anyhow::Result<bool> {
|
||||
+ // The miner often reboots before replying, so any error is treated as
|
||||
+ // "rebooting".
|
||||
+ let _ = self.write_rpc.send_command("reboot", true, None).await;
|
||||
+ Ok(true)
|
||||
+ }
|
||||
fn supports_restart(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Pause for WhatsMinerV1 {
|
||||
+ #[allow(unused_variables)]
|
||||
+ async fn pause(&self, at_time: Option<Duration>) -> anyhow::Result<bool> {
|
||||
+ // Fire-and-forget: the miner may power off before responding.
|
||||
+ let _ = self
|
||||
+ .write_rpc
|
||||
+ .send_command("power_off", true, Some(json!({"respbefore": "true"})))
|
||||
+ .await;
|
||||
+ Ok(true)
|
||||
+ }
|
||||
fn supports_pause(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Resume for WhatsMinerV1 {
|
||||
+ #[allow(unused_variables)]
|
||||
+ async fn resume(&self, at_time: Option<Duration>) -> anyhow::Result<bool> {
|
||||
+ let data = self.write_rpc.send_command("power_on", true, None).await;
|
||||
+ Ok(data.is_ok())
|
||||
+ }
|
||||
fn supports_resume(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -643,7 +731,13 @@ impl UpgradeFirmware for WhatsMinerV1 {
|
||||
}
|
||||
}
|
||||
|
||||
-impl HasAuth for WhatsMinerV1 {}
|
||||
+impl HasAuth for WhatsMinerV1 {
|
||||
+ fn set_auth(&mut self, auth: MinerAuth) {
|
||||
+ // WhatsMiner's token account is always "admin"; only the password varies.
|
||||
+ // Route it to the privileged write RPC (round 12 #8b part 2).
|
||||
+ self.write_rpc.set_auth(MinerAuth::new("admin", auth.password()));
|
||||
+ }
|
||||
+}
|
||||
impl HasDefaultAuth for WhatsMinerV1 {}
|
||||
|
||||
impl Validate for WhatsMinerV1 {
|
||||
@@ -0,0 +1,143 @@
|
||||
Subject: [PATCH 0008] antminer: resolve Z15J / unknown-model algorithm
|
||||
|
||||
Round-13 #4/#5. A Z15J reports its model as "ANTMINER Z15J", which asic-rs' alias
|
||||
table did not recognise, so it deserialised to AntMinerModel::Unknown and its
|
||||
hash algorithm resolved to HashAlgorithm::Unknown. That left the miner's Sol/s
|
||||
hashrate un-bucketed as "unknown hashrate" in the GUI, even though the round-10
|
||||
unit reinterpretation already read the value correctly. (The older ANTMINER Z15
|
||||
matched the table and reported Equihash; only the J revision was affected.)
|
||||
|
||||
Two layers of fix:
|
||||
- models.rs / hardware.rs: add a first-class Z15J model (Equihash, same 3-chip
|
||||
x 3-board / 2-fan chassis profile as the Z15) so it parses to a named model
|
||||
and carries the right algorithm, and shows a clean "Z15J" model name.
|
||||
- v2020 backend: when the alias table still can't place a model, infer the
|
||||
algorithm from the Antminer family letter for the lines that are
|
||||
single-algorithm end to end (Z -> Equihash, L -> Scrypt, S/T -> SHA-256), so
|
||||
other not-yet-tabled models are bucketed sensibly instead of Unknown.
|
||||
Ambiguous families (K spans Kadena/KHeavyHash/Eaglesong; DR is Blake256 while
|
||||
D is X11) are deliberately left Unknown rather than guessed wrong.
|
||||
|
||||
Live-verified on 10.5.1.{50,72,196,205}: Z15 and Z15J now both report
|
||||
algo=Equihash with their real Sol/s rates (e.g. 305k, 132k; 0 on idle units).
|
||||
The antminer crate tests pass, plus two new unit tests (z15j_parses_as_equihash,
|
||||
unknown_models_infer_algo_from_family_letter).
|
||||
|
||||
diff --git a/vendor/asic-rs-makes-antminer/src/models.rs b/vendor/asic-rs-makes-antminer/src/models.rs
|
||||
--- a/vendor/asic-rs-makes-antminer/src/models.rs
|
||||
+++ b/vendor/asic-rs-makes-antminer/src/models.rs
|
||||
@@ -78,6 +78,9 @@
|
||||
#[serde(alias = "ANTMINER Z15 PRO")]
|
||||
#[algorithm(HashAlgorithm::Equihash)]
|
||||
Z15Pro,
|
||||
+ #[serde(alias = "ANTMINER Z15J")]
|
||||
+ #[algorithm(HashAlgorithm::Equihash)]
|
||||
+ Z15J,
|
||||
#[serde(alias = "ANTMINER S17")]
|
||||
#[algorithm(HashAlgorithm::SHA256)]
|
||||
S17,
|
||||
@@ -281,12 +284,22 @@
|
||||
(AntMinerModel::E9Pro, HashAlgorithm::EtHash),
|
||||
(AntMinerModel::Z15, HashAlgorithm::Equihash),
|
||||
(AntMinerModel::Z15Pro, HashAlgorithm::Equihash),
|
||||
+ (AntMinerModel::Z15J, HashAlgorithm::Equihash),
|
||||
] {
|
||||
assert_eq!(model.hash_algorithm(), expected, "{model}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
+ fn z15j_parses_as_equihash() {
|
||||
+ // The Z15J reports "ANTMINER Z15J"; before it had an alias it fell back to
|
||||
+ // Unknown, which left its Sol/s hashrate un-bucketed (round 13 #5).
|
||||
+ let model = AntMinerModel::from_str("ANTMINER Z15J").unwrap();
|
||||
+ assert_eq!(model, AntMinerModel::Z15J);
|
||||
+ assert_eq!(model.hash_algorithm(), HashAlgorithm::Equihash);
|
||||
+ }
|
||||
+
|
||||
+ #[test]
|
||||
fn unknown_model_uses_unknown_algorithm() {
|
||||
let model = AntMinerModel::from_str("ANTMINER S99").unwrap();
|
||||
|
||||
diff --git a/vendor/asic-rs-makes-antminer/src/hardware.rs b/vendor/asic-rs-makes-antminer/src/hardware.rs
|
||||
--- a/vendor/asic-rs-makes-antminer/src/hardware.rs
|
||||
+++ b/vendor/asic-rs-makes-antminer/src/hardware.rs
|
||||
@@ -97,6 +97,10 @@
|
||||
AntMinerModel::Z15Pro => Self {
|
||||
fans: Some(2),
|
||||
boards: Some(vec![Some(6), Some(6), Some(6)]),
|
||||
+ },
|
||||
+ AntMinerModel::Z15J => Self {
|
||||
+ fans: Some(2),
|
||||
+ boards: Some(vec![Some(3), Some(3), Some(3)]),
|
||||
},
|
||||
AntMinerModel::S17 => Self {
|
||||
fans: Some(4),
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
@@ -201,10 +201,41 @@
|
||||
Value::Object(payload)
|
||||
}
|
||||
|
||||
+/// Infer an Antminer's hash algorithm from its model-family letter, for models
|
||||
+/// asic-rs' alias table doesn't recognise (round 13 #5). Only the families whose
|
||||
+/// entire product line shares one algorithm are inferred; anything ambiguous
|
||||
+/// (the K-series spans Kadena/KHeavyHash/Eaglesong, DR is Blake256 while D is
|
||||
+/// X11) is left Unknown rather than guessed wrong.
|
||||
+fn infer_antminer_algo(model: &str) -> HashAlgorithm {
|
||||
+ let upper = model.to_ascii_uppercase();
|
||||
+ let name = upper
|
||||
+ .strip_prefix("ANTMINER ")
|
||||
+ .unwrap_or(&upper)
|
||||
+ .trim_start();
|
||||
+ match name.chars().next() {
|
||||
+ // Z9 / Z11 / Z15 / Z15 Pro / Z15J -- the whole Z line is Equihash.
|
||||
+ Some('Z') => HashAlgorithm::Equihash,
|
||||
+ // L3+ / L7 / L9 / L11 -- the whole L line is Scrypt.
|
||||
+ Some('L') => HashAlgorithm::Scrypt,
|
||||
+ // S9..S21 and T9..T21 (and future revisions) are all SHA-256.
|
||||
+ Some('S') | Some('T') => HashAlgorithm::SHA256,
|
||||
+ _ => HashAlgorithm::Unknown,
|
||||
+ }
|
||||
+}
|
||||
+
|
||||
impl AntMinerV2020 {
|
||||
pub fn new(ip: IpAddr, model: impl MinerModel) -> Self {
|
||||
let auth = Self::default_auth();
|
||||
- let algo = model.hash_algorithm();
|
||||
+ // asic-rs maps a model string to its algorithm through a fixed alias
|
||||
+ // table; a model that is not in the table (a Z15J, a not-yet-added
|
||||
+ // S-series, ...) resolves to HashAlgorithm::Unknown, which then leaves the
|
||||
+ // miner's hashrate un-bucketed ("unknown hashrate", round 13 #5). When the
|
||||
+ // table can't place the model, infer the algorithm from its Antminer
|
||||
+ // family letter for the lines that are single-algorithm end to end.
|
||||
+ let algo = match model.hash_algorithm() {
|
||||
+ HashAlgorithm::Unknown => infer_antminer_algo(&model.to_string()),
|
||||
+ known => known,
|
||||
+ };
|
||||
AntMinerV2020 {
|
||||
ip,
|
||||
rpc: AntMinerRPCAPI::new(ip),
|
||||
@@ -1431,6 +1462,21 @@
|
||||
};
|
||||
|
||||
#[test]
|
||||
+ fn unknown_models_infer_algo_from_family_letter() {
|
||||
+ // Round 13 #5: a model outside asic-rs' alias table must still resolve a
|
||||
+ // sensible algorithm from its Antminer family letter instead of Unknown.
|
||||
+ assert_eq!(infer_antminer_algo("ANTMINER Z15J"), HashAlgorithm::Equihash);
|
||||
+ assert_eq!(infer_antminer_algo("Z9"), HashAlgorithm::Equihash);
|
||||
+ assert_eq!(infer_antminer_algo("ANTMINER L15"), HashAlgorithm::Scrypt);
|
||||
+ assert_eq!(infer_antminer_algo("ANTMINER S23"), HashAlgorithm::SHA256);
|
||||
+ assert_eq!(infer_antminer_algo("ANTMINER T23"), HashAlgorithm::SHA256);
|
||||
+ // Ambiguous / unrelated families stay Unknown (K-series spans three
|
||||
+ // algorithms; a bare unknown string has no family).
|
||||
+ assert_eq!(infer_antminer_algo("ANTMINER KS7"), HashAlgorithm::Unknown);
|
||||
+ assert_eq!(infer_antminer_algo("WHATSMINER M30"), HashAlgorithm::Unknown);
|
||||
+ }
|
||||
+
|
||||
+ #[test]
|
||||
fn set_miner_conf_payload_matches_cgi_contract_for_pause_resume() {
|
||||
let pre = json!({
|
||||
"pools": [
|
||||
@@ -0,0 +1,39 @@
|
||||
Subject: [PATCH 0009] antminer: read Z15-style fans from higher fan slots
|
||||
|
||||
Round-15 #12. The v2020 backend's parse_fans only read fan1..hardware.fans, but
|
||||
some models report their fans in higher slots and leave the low ones at 0 -- the
|
||||
Z15 has fan_num=2 yet reports its two fans in fan3/fan4 with fan1/fan2 = 0, so no
|
||||
fans were read. Scan a generous range of fan slots (1..16) and collect the
|
||||
non-zero readings instead, renumbered 0.. in the order found. Verified against a
|
||||
live Z15 (fan3=4920, fan4=5160). The antminer crate tests pass unchanged.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
index 0ce462c9..38935a59 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
@@ -833,15 +833,23 @@ impl GetFans for AntMinerV2020 {
|
||||
let mut fans: Vec<FanData> = Vec::new();
|
||||
|
||||
if let Some(stats_data) = data.get(&DataField::Fans) {
|
||||
- for i in 1..=self.device_info.hardware.fans.unwrap_or(4) {
|
||||
+ // Some models report their fans in higher fan slots and leave the low
|
||||
+ // ones at 0 -- the Z15, for example, has fan_num=2 but reports its two
|
||||
+ // fans in fan3/fan4 with fan1/fan2 = 0. So scan a generous range of
|
||||
+ // slots and collect the non-zero readings rather than only reading
|
||||
+ // fan1..hardware.fans (which missed the Z15 entirely). The collected
|
||||
+ // fans are renumbered 0.. in the order found (round 14 #12).
|
||||
+ let mut pos: i16 = 0;
|
||||
+ for i in 1..=16 {
|
||||
if let Some(fan_speed) =
|
||||
stats_data.get(format!("fan{}", i)).and_then(|v| v.as_f64())
|
||||
&& fan_speed > 0.0
|
||||
{
|
||||
fans.push(FanData {
|
||||
- position: (i - 1) as i16,
|
||||
+ position: pos,
|
||||
rpm: Some(AngularVelocity::from_rpm(fan_speed)),
|
||||
});
|
||||
+ pos += 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
Subject: [PATCH 0010] antminer: fix v2020 locate-LED + reboot for the legacy web UI
|
||||
|
||||
Round-15 #7. On old (< 2023.07) Antminer firmware -- the LuCI-derived web UI, e.g.
|
||||
the Z15/Z15J -- the "flash the locate light" action never worked: set_fault_light
|
||||
returned Ok(false) on real hardware even though the request "succeeded".
|
||||
|
||||
Root cause (confirmed against a live Z15): that firmware's blink.cgi does NOT take
|
||||
the JSON body {"blink":"true"} the backend sent (it silently ignores it, answering
|
||||
200 with an empty text/html body, so the JSON parse fails and the error is swallowed
|
||||
into Ok(false)). Its own blink.html instead POSTs a form field action=startBlink /
|
||||
stopBlink, and reads state back with action=onPageLoaded -> {"isBlinking":bool}.
|
||||
The action handler also frequently answers 401/500 even when the toggle succeeds, so
|
||||
its HTTP status is not a reliable success signal.
|
||||
|
||||
Fix: add send_web_form_command (application/x-www-form-urlencoded POST; this reqwest
|
||||
build has no .form()); blink() now fires action=startBlink/stopBlink, ignores the
|
||||
unreliable status, and reads the real state back via onPageLoaded; set_fault_light
|
||||
reports success only when the observed isBlinking matches the request. The LightFlashing
|
||||
data read is routed to the same onPageLoaded path (get_blink_status.cgi is 404 on this
|
||||
firmware) and remapped to {"blink":bool} so the shared /blink extractor still works.
|
||||
|
||||
Also fixes reboot() for the same generation: reboot.html does type:'GET', but the
|
||||
backend POSTed to reboot.cgi. Switched to GET to match the vendor UI (the Restart
|
||||
action was affected). Not live-fired, to avoid rebooting production miners.
|
||||
|
||||
Verified live: Z15 and Z15J now return set_fault_light(on/off) -> Ok(true) with the
|
||||
light genuinely toggling; VNish (AMLogic/CVITek/Xilinx/BeagleBoneBlack) and WhatsMiner
|
||||
(H6OS/H616) remain Ok(true) with no regression.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
index 38935a59..bd8662b1 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/mod.rs
|
||||
@@ -1111,9 +1111,17 @@ impl SetFaultLight for AntMinerV2020 {
|
||||
true
|
||||
}
|
||||
|
||||
- #[allow(unused_variables)]
|
||||
async fn set_fault_light(&self, fault: bool) -> anyhow::Result<bool> {
|
||||
- Ok(self.web.blink(fault).await.is_ok())
|
||||
+ // `blink()` fires the toggle then reads the state back as `{"isBlinking":
|
||||
+ // bool}` (the legacy CGI's own HTTP status is unreliable). Report success
|
||||
+ // only when the observed locate-LED state matches what was requested.
|
||||
+ let observed = self
|
||||
+ .web
|
||||
+ .blink(fault)
|
||||
+ .await?
|
||||
+ .get("isBlinking")
|
||||
+ .and_then(serde_json::Value::as_bool);
|
||||
+ Ok(observed == Some(fault))
|
||||
}
|
||||
}
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/web.rs b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/web.rs
|
||||
index 7d6f237c..a50cc4ee 100644
|
||||
--- a/vendor/asic-rs-firmwares-antminer/src/backends/v2020/web.rs
|
||||
+++ b/vendor/asic-rs-firmwares-antminer/src/backends/v2020/web.rs
|
||||
@@ -240,6 +240,45 @@ impl AntMinerWebAPI {
|
||||
Ok(response)
|
||||
}
|
||||
|
||||
+ /// POST a form-encoded (`application/x-www-form-urlencoded`) body to a CGI
|
||||
+ /// endpoint and parse the JSON reply. The legacy LuCI web UI endpoints (e.g.
|
||||
+ /// `blink.cgi`) expect `action=...` form fields, not a JSON body. An empty
|
||||
+ /// reply parses to `{}`; a non-2xx status bails.
|
||||
+ async fn send_web_form_command(&self, command: &str, form: &[(&str, &str)]) -> Result<Value> {
|
||||
+ let url = format!("http://{}:{}/cgi-bin/{}.cgi", self.ip, self.port, command);
|
||||
+ // Build an application/x-www-form-urlencoded body by hand (this reqwest
|
||||
+ // build has no `.form()` helper). The only fields used are `action` with
|
||||
+ // fixed ASCII values, so percent-encoding is unnecessary.
|
||||
+ let body = form
|
||||
+ .iter()
|
||||
+ .map(|(k, v)| format!("{k}={v}"))
|
||||
+ .collect::<Vec<_>>()
|
||||
+ .join("&");
|
||||
+ let response = self
|
||||
+ .client()?
|
||||
+ .post(&url)
|
||||
+ .header(
|
||||
+ reqwest::header::CONTENT_TYPE,
|
||||
+ "application/x-www-form-urlencoded",
|
||||
+ )
|
||||
+ .body(body)
|
||||
+ .timeout(self.timeout)
|
||||
+ .send_digest_auth((self.auth.username(), self.auth.password()))
|
||||
+ .await
|
||||
+ .map_err(|e| anyhow!(e.to_string()))?;
|
||||
+
|
||||
+ let status = response.status();
|
||||
+ if !status.is_success() {
|
||||
+ bail!("HTTP request failed with status code {}", status);
|
||||
+ }
|
||||
+ let text = response.text().await.map_err(|e| anyhow!(e.to_string()))?;
|
||||
+ if text.trim().is_empty() {
|
||||
+ Ok(json!({}))
|
||||
+ } else {
|
||||
+ serde_json::from_str(&text).map_err(|e| anyhow!(e.to_string()))
|
||||
+ }
|
||||
+ }
|
||||
+
|
||||
pub async fn get_miner_conf(&self) -> Result<Value> {
|
||||
self.send_web_command("get_miner_conf", false, None, Method::GET)
|
||||
.await
|
||||
@@ -257,17 +296,31 @@ impl AntMinerWebAPI {
|
||||
}
|
||||
|
||||
pub async fn blink(&self, blink: bool) -> Result<Value> {
|
||||
- let param = if blink {
|
||||
- json!({"blink": "true"})
|
||||
- } else {
|
||||
- json!({"blink": "false"})
|
||||
- };
|
||||
- self.send_web_command("blink", false, Some(param), Method::POST)
|
||||
+ // Legacy LuCI web UI: the locate LED is toggled by POSTing an `action`
|
||||
+ // form field to blink.cgi (`startBlink`/`stopBlink`) -- NOT a JSON body
|
||||
+ // like the newer (>= 2023.07) firmware expects. The handler performs the
|
||||
+ // action but frequently answers 401/500 even on success, so its HTTP
|
||||
+ // status is not a reliable signal: fire it, ignore the response, then read
|
||||
+ // the real state back via `onPageLoaded`.
|
||||
+ let action = if blink { "startBlink" } else { "stopBlink" };
|
||||
+ let _ = self
|
||||
+ .send_web_form_command("blink", &[("action", action)])
|
||||
+ .await;
|
||||
+ self.blink_status().await
|
||||
+ }
|
||||
+
|
||||
+ /// Query the locate-LED state via the legacy blink.cgi `onPageLoaded` action,
|
||||
+ /// which reliably answers `200 {"isBlinking": bool}`.
|
||||
+ pub async fn blink_status(&self) -> Result<Value> {
|
||||
+ self.send_web_form_command("blink", &[("action", "onPageLoaded")])
|
||||
.await
|
||||
}
|
||||
|
||||
pub async fn reboot(&self) -> Result<Value> {
|
||||
- self.send_web_command("reboot", false, None, Method::POST)
|
||||
+ // The legacy LuCI web UI reboots via GET /cgi-bin/reboot.cgi (its own
|
||||
+ // reboot.html does `type: 'GET'`); a POST is not what this firmware
|
||||
+ // generation expects.
|
||||
+ self.send_web_command("reboot", false, None, Method::GET)
|
||||
.await
|
||||
}
|
||||
|
||||
@@ -350,8 +403,17 @@ impl AntMinerWebAPI {
|
||||
}
|
||||
|
||||
pub async fn get_blink_status(&self) -> Result<Value> {
|
||||
- self.send_web_command("get_blink_status", false, None, Method::GET)
|
||||
- .await
|
||||
+ // The old firmware has no `get_blink_status.cgi` (it answers 404); the
|
||||
+ // locate state lives behind blink.cgi's `onPageLoaded` action as
|
||||
+ // `{"isBlinking": bool}`. Remap it to `{"blink": bool}` so the shared
|
||||
+ // LightFlashing extractor (key `/blink`) keeps working.
|
||||
+ let flashing = self
|
||||
+ .blink_status()
|
||||
+ .await?
|
||||
+ .get("isBlinking")
|
||||
+ .and_then(Value::as_bool)
|
||||
+ .unwrap_or(false);
|
||||
+ Ok(json!({ "blink": flashing }))
|
||||
}
|
||||
|
||||
pub async fn set_network_conf(
|
||||
@@ -383,10 +445,16 @@ impl APIClient for AntMinerWebAPI {
|
||||
MinerCommand::WebAPI {
|
||||
command,
|
||||
parameters,
|
||||
- } => self
|
||||
- .send_web_command(command, false, parameters.clone(), Method::GET)
|
||||
- .await
|
||||
- .map_err(|e| anyhow!(e.to_string())),
|
||||
+ } => {
|
||||
+ // The legacy blink status lives behind a POST form action, not a
|
||||
+ // GET .cgi (which 404s), so route it through the dedicated helper.
|
||||
+ if *command == "get_blink_status" {
|
||||
+ return self.get_blink_status().await;
|
||||
+ }
|
||||
+ self.send_web_command(command, false, parameters.clone(), Method::GET)
|
||||
+ .await
|
||||
+ .map_err(|e| anyhow!(e.to_string()))
|
||||
+ }
|
||||
_ => Err(anyhow!("Unsupported command type for Web client")),
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,162 @@
|
||||
Subject: [PATCH 0011] luxminer: implement set_power_limit; epic: document PSU gating
|
||||
|
||||
Round-15 follow-up. The toolkit reported supports_power_limit=false for LuxOS and
|
||||
ePIC (UMC OS) miners. Investigated against the live corpus (S19j Pro on both).
|
||||
|
||||
LuxOS: genuinely under-reported. LuxOS tunes by discrete named profiles, each
|
||||
carrying a Watts rating (the `profiles` RPC returns Step + Watts), applied with
|
||||
profileset -- pure frequency/voltage tuning, no special PSU needed. Implemented
|
||||
SetPowerLimit by mapping the requested watts to the highest profile whose Watts
|
||||
does not exceed it (or the lowest profile when the target is below all of them),
|
||||
then profileset. supports_set_power_limit now returns true. The pure mapping is
|
||||
factored into parse_profile_watts + select_profile_at_or_below with a unit test.
|
||||
Verified live: set_power_limit(2500) on an S19j Pro selected step -4 (2385 W, the
|
||||
highest <= 2500) and the miner's active profile became 445MHz/-4.
|
||||
|
||||
ePIC: NOT under-reporting after all -- left at false, with a comment explaining
|
||||
why. ePIC PowerPlay's only true power-limit path is the PowerTune perpetual-tune
|
||||
algorithm, which the firmware gates on the PSU: on a fixed-voltage Bitmain PSU
|
||||
(the APW12 on an S19j Pro) perpetualtune/algo rejects it with "Power optimization
|
||||
is not supported by this PSU". That support is a per-PSU runtime property this
|
||||
synchronous, no-I/O capability check cannot observe, so advertising true would
|
||||
over-report on most reflashed Antminers. (Hashrate tuning stays available via
|
||||
set_tuning_config.)
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-epic/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-epic/src/backends/v1/mod.rs
|
||||
index a6f555f7..c21e05b1 100644
|
||||
--- a/vendor/asic-rs-firmwares-epic/src/backends/v1/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-epic/src/backends/v1/mod.rs
|
||||
@@ -1369,6 +1369,14 @@ impl SetFaultLight for PowerPlayV1 {
|
||||
#[async_trait]
|
||||
impl SetPowerLimit for PowerPlayV1 {
|
||||
fn supports_set_power_limit(&self) -> bool {
|
||||
+ // ePIC PowerPlay's only true power-limit mechanism is the PowerTune
|
||||
+ // perpetual-tune algorithm, which the firmware gates on the PSU: on a
|
||||
+ // fixed-voltage Bitmain PSU (e.g. the APW12 on an S19j Pro) the
|
||||
+ // perpetualtune/algo endpoint rejects it with "Power optimization is not
|
||||
+ // supported by this PSU". Since that support is a per-PSU runtime property
|
||||
+ // that this synchronous, no-I/O capability check cannot observe, report
|
||||
+ // false rather than over-advertise a control that fails on most reflashed
|
||||
+ // Antminers. (Hashrate tuning is exposed separately via set_tuning_config.)
|
||||
false
|
||||
}
|
||||
}
|
||||
diff --git a/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs
|
||||
index af89167c..aac39eb6 100644
|
||||
--- a/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs
|
||||
@@ -1052,10 +1052,66 @@ impl SetFaultLight for LuxMinerV1 {
|
||||
}
|
||||
}
|
||||
|
||||
+/// Parse a LuxOS `profiles` RPC reply into (step name, watts) pairs, keeping only
|
||||
+/// profiles that report both a `Step` and a `Watts` value.
|
||||
+fn parse_profile_watts(profiles: &Value) -> Vec<(String, f64)> {
|
||||
+ profiles
|
||||
+ .get("PROFILES")
|
||||
+ .and_then(Value::as_array)
|
||||
+ .map(|arr| {
|
||||
+ arr.iter()
|
||||
+ .filter_map(|p| {
|
||||
+ let step = p.get("Step").and_then(Value::as_str)?.to_string();
|
||||
+ let watts = p.get("Watts").and_then(Value::as_f64)?;
|
||||
+ Some((step, watts))
|
||||
+ })
|
||||
+ .collect()
|
||||
+ })
|
||||
+ .unwrap_or_default()
|
||||
+}
|
||||
+
|
||||
+/// Choose the LuxOS profile step to satisfy a watts power limit: the highest-watt
|
||||
+/// profile that does not exceed `target_w`, or -- when the target is below every
|
||||
+/// profile -- the lowest-watt profile. Returns None only when there are no
|
||||
+/// profiles to choose from.
|
||||
+fn select_profile_at_or_below(steps: &[(String, f64)], target_w: f64) -> Option<String> {
|
||||
+ if steps.is_empty() {
|
||||
+ return None;
|
||||
+ }
|
||||
+ let mut sorted: Vec<&(String, f64)> = steps.iter().collect();
|
||||
+ sorted.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap_or(std::cmp::Ordering::Equal));
|
||||
+ sorted
|
||||
+ .iter()
|
||||
+ .rev()
|
||||
+ .find(|(_, w)| *w <= target_w)
|
||||
+ .or_else(|| sorted.first())
|
||||
+ .map(|(s, _)| s.clone())
|
||||
+}
|
||||
+
|
||||
#[async_trait]
|
||||
impl SetPowerLimit for LuxMinerV1 {
|
||||
fn supports_set_power_limit(&self) -> bool {
|
||||
- false
|
||||
+ true
|
||||
+ }
|
||||
+
|
||||
+ async fn set_power_limit(&self, power: Power) -> anyhow::Result<bool> {
|
||||
+ // LuxOS tunes by discrete named profiles (each carries a Watts rating),
|
||||
+ // not a raw watts setpoint. Map the requested limit to the highest profile
|
||||
+ // whose Watts does not exceed it (or the lowest profile when the target is
|
||||
+ // below every profile), then apply it with profileset.
|
||||
+ let profiles = self.rpc.profiles().await?;
|
||||
+ let steps = parse_profile_watts(&profiles);
|
||||
+ let Some(chosen) = select_profile_at_or_below(&steps, power.as_watts()) else {
|
||||
+ anyhow::bail!("LuxOS reported no tunable profiles with a Step/Watts pair");
|
||||
+ };
|
||||
+ let resp = self.rpc.profileset(&chosen).await?;
|
||||
+ // LuxOS answers with a STATUS array; "S"/"I" is success. A missing status
|
||||
+ // after a non-error reply is treated as applied.
|
||||
+ Ok(resp
|
||||
+ .pointer("/STATUS/0/STATUS")
|
||||
+ .and_then(Value::as_str)
|
||||
+ .map(|s| matches!(s, "S" | "I"))
|
||||
+ .unwrap_or(true))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1231,6 +1287,46 @@ mod tests {
|
||||
POWER, PROFILES, STATS, SUMMARY, TEMPS, VERSION, VOLTAGEGET_0, VOLTAGEGET_1, VOLTAGEGET_2,
|
||||
};
|
||||
|
||||
+ #[test]
|
||||
+ fn power_limit_profile_selection() {
|
||||
+ // LuxOS reports a ladder of profiles, each with a Step name and Watts.
|
||||
+ let steps = vec![
|
||||
+ ("-16".to_string(), 865.0),
|
||||
+ ("-4".to_string(), 2385.0),
|
||||
+ ("-2".to_string(), 2790.0),
|
||||
+ ("0".to_string(), 3100.0),
|
||||
+ ];
|
||||
+ // The highest profile at or below the requested watts limit.
|
||||
+ assert_eq!(
|
||||
+ select_profile_at_or_below(&steps, 2500.0).as_deref(),
|
||||
+ Some("-4")
|
||||
+ );
|
||||
+ assert_eq!(
|
||||
+ select_profile_at_or_below(&steps, 2790.0).as_deref(),
|
||||
+ Some("-2")
|
||||
+ );
|
||||
+ // Above every profile -> the maximum profile (a limit can't exceed the
|
||||
+ // hardware's top profile).
|
||||
+ assert_eq!(
|
||||
+ select_profile_at_or_below(&steps, 9000.0).as_deref(),
|
||||
+ Some("0")
|
||||
+ );
|
||||
+ // Below every profile -> the minimum profile.
|
||||
+ assert_eq!(
|
||||
+ select_profile_at_or_below(&steps, 100.0).as_deref(),
|
||||
+ Some("-16")
|
||||
+ );
|
||||
+ // No profiles -> nothing to choose.
|
||||
+ assert_eq!(select_profile_at_or_below(&[], 2500.0), None);
|
||||
+
|
||||
+ // parse_profile_watts against the captured LuxOS `profiles` reply: it
|
||||
+ // yields tunable profiles and selection finds a real step among them.
|
||||
+ let profiles: Value = serde_json::from_str(PROFILES).unwrap();
|
||||
+ let parsed = parse_profile_watts(&profiles);
|
||||
+ assert!(!parsed.is_empty(), "fixture should carry tunable profiles");
|
||||
+ assert!(select_profile_at_or_below(&parsed, 2500.0).is_some());
|
||||
+ }
|
||||
+
|
||||
#[tokio::test]
|
||||
|
||||
async fn test_luxminer_v1() -> anyhow::Result<()> {
|
||||
@@ -0,0 +1,229 @@
|
||||
Subject: [PATCH 0012] whatsminer: robust per-component fault messages (V1 source + malformed-array repair)
|
||||
|
||||
Round-16 #1/#3. The toolkit could not attribute WhatsMiner faults to specific
|
||||
hashboards. Two backend gaps, both found against live H6OS units:
|
||||
|
||||
1. V1 backend sourced messages from `summary` (/SUMMARY/0 "Error Code N"), which
|
||||
is empty on these units -- the real faults are in get_error_code, like V2/V3.
|
||||
Repointed DataField::Messages to get_error_code (/Msg/error_code) and rewrote
|
||||
parse_messages to read the {code: timestamp} array (mirroring V2). asic-rs's
|
||||
error_codes::error_info already maps each code to a MinerComponent (HashBoard
|
||||
idx / PowerSupply / Fan / ControlBoard) and human text.
|
||||
|
||||
2. Some firmware emits an INVALID error_code array of bare "code":"timestamp"
|
||||
pairs (`["540":"..","541":".."]`) instead of objects (`[{"540":".."}]`), which
|
||||
fails the whole response parse so no messages surface at all. Added
|
||||
error_codes::repair_error_code_array (targeted, no-op on valid input) and call
|
||||
it in the V1 and V2 RPC read paths before parsing.
|
||||
|
||||
Verified live: 10.7.1.231 -> PowerSupply errors 205/206/217/251; 10.8.1.234 (the
|
||||
malformed-array unit) -> 540 HashBoard 0, 541/561 HashBoard 1, 600 miner-level --
|
||||
board 2 correctly clean. Unit test covers the repair; whatsminer tests pass.
|
||||
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
index c9c96713..67907049 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/mod.rs
|
||||
@@ -117,6 +117,10 @@ impl GetDataLocations for WhatsMinerV1 {
|
||||
command: "get_psu",
|
||||
parameters: None,
|
||||
};
|
||||
+ const RPC_GET_ERROR_CODE: MinerCommand = MinerCommand::RPC {
|
||||
+ command: "get_error_code",
|
||||
+ parameters: None,
|
||||
+ };
|
||||
|
||||
match data_field {
|
||||
DataField::Mac => vec![(
|
||||
@@ -254,10 +258,10 @@ impl GetDataLocations for WhatsMinerV1 {
|
||||
},
|
||||
)],
|
||||
DataField::Messages => vec![(
|
||||
- RPC_SUMMARY,
|
||||
+ RPC_GET_ERROR_CODE,
|
||||
DataExtractor {
|
||||
func: get_by_pointer,
|
||||
- key: Some("/SUMMARY/0"),
|
||||
+ key: Some("/Msg/error_code"),
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
@@ -471,32 +475,43 @@ impl GetTuningCapabilities for WhatsMinerV1 {}
|
||||
impl GetLightFlashing for WhatsMinerV1 {}
|
||||
impl GetMessages for WhatsMinerV1 {
|
||||
fn parse_messages(&self, data: &HashMap<DataField, Value>) -> Vec<MinerMessage> {
|
||||
+ // WhatsMiner V1 (H6OS) reports faults via get_error_code -> Msg.error_code,
|
||||
+ // an array of {code: timestamp} objects (the same shape as V2/V3; the RPC
|
||||
+ // layer repairs the occasional invalid bare-pair array first). The older
|
||||
+ // summary "Error Code N" fields are frequently empty on these units.
|
||||
let mut messages = Vec::new();
|
||||
-
|
||||
- let error_count = data
|
||||
- .get(&DataField::Messages)
|
||||
- .and_then(|val| {
|
||||
- val.pointer("/Error Code Count")
|
||||
- .and_then(|val| val.as_u64())
|
||||
- })
|
||||
- .unwrap_or(0u64) as usize;
|
||||
- for idx in 0..error_count {
|
||||
- let e_code = data
|
||||
- .get(&DataField::Messages)
|
||||
- .and_then(|val| val.pointer(&format!("/Error Code {}", idx)))
|
||||
- .and_then(|val| val.as_u64());
|
||||
- if let Some(code) = e_code {
|
||||
- let info = crate::error_codes::error_info(code);
|
||||
+ let Some(errors) = data.get(&DataField::Messages) else {
|
||||
+ return messages;
|
||||
+ };
|
||||
+ for obj in errors.as_array().unwrap_or(&Vec::new()).iter() {
|
||||
+ let Some(obj) = obj.as_object() else {
|
||||
+ continue;
|
||||
+ };
|
||||
+ for (code, time) in obj.iter() {
|
||||
+ let Some(time_str) = time.as_str() else {
|
||||
+ continue;
|
||||
+ };
|
||||
+ let timestamp =
|
||||
+ chrono::NaiveDateTime::parse_from_str(time_str, "%Y-%m-%d %H:%M:%S")
|
||||
+ .map(|t| {
|
||||
+ chrono::DateTime::<chrono::Utc>::from_naive_utc_and_offset(
|
||||
+ t,
|
||||
+ chrono::Utc,
|
||||
+ )
|
||||
+ })
|
||||
+ .map(|dt| dt.timestamp() as u32)
|
||||
+ .unwrap_or(0);
|
||||
+ let parsed_code = code.parse::<u64>().unwrap_or(0);
|
||||
+ let info = crate::error_codes::error_info(parsed_code);
|
||||
messages.push(MinerMessage::with_component(
|
||||
- 0,
|
||||
- code,
|
||||
+ timestamp,
|
||||
+ parsed_code,
|
||||
info.message,
|
||||
MessageSeverity::Error,
|
||||
info.component,
|
||||
));
|
||||
}
|
||||
}
|
||||
-
|
||||
messages
|
||||
}
|
||||
}
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/rpc.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/rpc.rs
|
||||
index 6e6c604e..384bbcd3 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/rpc.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v1/rpc.rs
|
||||
@@ -106,6 +106,9 @@ impl RPCAPIClient for WhatsMinerRPCAPI {
|
||||
let response = response
|
||||
.replace('\n', "") // Fix for WM V1, can have newlines in version which breaks the json parser
|
||||
.replace(",}", "}"); // Fix for WM V1, can have trailing commas which breaks the json parser
|
||||
+ // Fix for WM V1 get_error_code, which can emit an invalid array of bare
|
||||
+ // "code":"timestamp" pairs (`["540":".."]`) that fails the whole parse.
|
||||
+ let response = crate::error_codes::repair_error_code_array(&response);
|
||||
|
||||
self.parse_rpc_result(&response)
|
||||
}
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/rpc.rs b/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/rpc.rs
|
||||
index 9eec7a93..99da6a89 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/rpc.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/backends/v2/rpc.rs
|
||||
@@ -202,6 +202,9 @@ impl WhatsMinerRPCAPI {
|
||||
read_stream_response(&mut stream, DEFAULT_RPC_TIMEOUT).await
|
||||
};
|
||||
let response = response?;
|
||||
+ // Repair the occasional invalid get_error_code array (bare
|
||||
+ // "code":"timestamp" pairs) before parsing; a no-op on valid responses.
|
||||
+ let response = crate::error_codes::repair_error_code_array(&response);
|
||||
|
||||
self.parse_rpc_result(&response)
|
||||
}
|
||||
diff --git a/vendor/asic-rs-firmwares-whatsminer/src/error_codes.rs b/vendor/asic-rs-firmwares-whatsminer/src/error_codes.rs
|
||||
index b442e9dc..5bd8b02a 100644
|
||||
--- a/vendor/asic-rs-firmwares-whatsminer/src/error_codes.rs
|
||||
+++ b/vendor/asic-rs-firmwares-whatsminer/src/error_codes.rs
|
||||
@@ -2,6 +2,56 @@ use asic_rs_core::data::message::MinerComponent;
|
||||
|
||||
const UNKNOWN: &str = "Unknown error type.";
|
||||
|
||||
+/// Repair an invalid `error_code` array emitted by some WhatsMiner firmware.
|
||||
+///
|
||||
+/// Certain (older, H6OS) firmwares report the fault list as bare
|
||||
+/// `"code":"timestamp"` pairs directly inside a JSON array
|
||||
+/// (`"error_code":["540":"..","541":".."]`) rather than an array of single-key
|
||||
+/// objects (`[{"540":".."},{"541":".."}]`). The bare form is not valid JSON and
|
||||
+/// fails the whole response parse, so no messages are surfaced at all. Rewrite the
|
||||
+/// bare pairs into objects; already-valid (object-wrapped or empty) arrays and
|
||||
+/// responses without an `error_code` array are returned unchanged.
|
||||
+pub fn repair_error_code_array(raw: &str) -> String {
|
||||
+ const KEY: &str = "\"error_code\":[";
|
||||
+ let Some(pos) = raw.find(KEY) else {
|
||||
+ return raw.to_string();
|
||||
+ };
|
||||
+ let open = pos + KEY.len() - 1; // index of the '['
|
||||
+ let bytes = raw.as_bytes();
|
||||
+ let mut depth = 0i32;
|
||||
+ let mut close = None;
|
||||
+ for (i, &b) in bytes.iter().enumerate().skip(open) {
|
||||
+ match b {
|
||||
+ b'[' => depth += 1,
|
||||
+ b']' => {
|
||||
+ depth -= 1;
|
||||
+ if depth == 0 {
|
||||
+ close = Some(i);
|
||||
+ break;
|
||||
+ }
|
||||
+ }
|
||||
+ _ => {}
|
||||
+ }
|
||||
+ }
|
||||
+ let Some(close) = close else {
|
||||
+ return raw.to_string();
|
||||
+ };
|
||||
+ let inner = &raw[open + 1..close];
|
||||
+ // Already valid (each entry object-wrapped) or empty -> leave untouched.
|
||||
+ if inner.trim().is_empty() || inner.contains('{') {
|
||||
+ return raw.to_string();
|
||||
+ }
|
||||
+ // Timestamps carry no commas, so a top-level comma split isolates each pair.
|
||||
+ let wrapped = inner
|
||||
+ .split(',')
|
||||
+ .map(str::trim)
|
||||
+ .filter(|s| !s.is_empty())
|
||||
+ .map(|pair| format!("{{{pair}}}"))
|
||||
+ .collect::<Vec<_>>()
|
||||
+ .join(",");
|
||||
+ format!("{}{}{}", &raw[..=open], wrapped, &raw[close..])
|
||||
+}
|
||||
+
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct ErrorInfo {
|
||||
pub message: String,
|
||||
@@ -514,6 +564,27 @@ fn serial_info_error(sub: u64, val: u64) -> String {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
+ #[test]
|
||||
+ fn repair_malformed_error_code_array() {
|
||||
+ // Bare "code":"timestamp" pairs inside the array (invalid JSON) -> objects.
|
||||
+ let bad = r#"{"STATUS":"S","Msg":{"error_code":["540":"2026-09-22 07:08:14","561":"2026-09-21 22:26:36"]},"Description":""}"#;
|
||||
+ let fixed = repair_error_code_array(bad);
|
||||
+ let v: serde_json::Value = serde_json::from_str(&fixed).expect("repaired JSON must parse");
|
||||
+ let arr = v["Msg"]["error_code"].as_array().unwrap();
|
||||
+ assert_eq!(arr.len(), 2);
|
||||
+ assert_eq!(arr[0]["540"], "2026-09-22 07:08:14");
|
||||
+ assert_eq!(arr[1]["561"], "2026-09-21 22:26:36");
|
||||
+
|
||||
+ // Already-valid (object-wrapped) arrays are returned unchanged.
|
||||
+ let good = r#"{"Msg":{"error_code":[{"205":"2026-09-20 03:35:44"}]}}"#;
|
||||
+ assert_eq!(repair_error_code_array(good), good);
|
||||
+ // Empty array and no-array responses are untouched.
|
||||
+ let empty = r#"{"Msg":{"error_code":[]}}"#;
|
||||
+ assert_eq!(repair_error_code_array(empty), empty);
|
||||
+ let none = r#"{"STATUS":"S"}"#;
|
||||
+ assert_eq!(repair_error_code_array(none), none);
|
||||
+ }
|
||||
+
|
||||
#[test]
|
||||
fn short_code_returns_unknown() {
|
||||
// Act
|
||||
@@ -0,0 +1,98 @@
|
||||
Subject: [PATCH 0013] braiins+luxminer: implement best-share / session-best-share (round 16 G9)
|
||||
|
||||
The GetBestShare/GetSessionBestShare traits had empty impls on every backend, so
|
||||
MinerData.best_share/session_best_share were always None and the toolkit's two
|
||||
"Best share" / "Session best" columns were dead.
|
||||
|
||||
Braiins v26_04: map DataField::BestShare to the already-fetched miner/stats WebAPI
|
||||
response (/miner_stats/best_share) and parse it. (BOS has no session-best field ->
|
||||
session stays None.) Verified live read-only on 10.4.1.83: 130601978.
|
||||
|
||||
LuxMiner v1: map DataField::BestShare + SessionBestShare to the already-fetched
|
||||
summary RPC (/SUMMARY/0/Best Share and /Best Session Share) and parse both.
|
||||
Verified live read-only on 10.4.1.60 (638881749/638881749) and 10.4.1.67
|
||||
(497802665/497802665).
|
||||
|
||||
No extra network calls (both reuse commands already collected by get_data).
|
||||
diff --git a/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/mod.rs b/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/mod.rs
|
||||
index fa947aee..e65fb201 100644
|
||||
--- a/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/mod.rs
|
||||
@@ -286,6 +286,14 @@ impl GetDataLocations for BraiinsV2604 {
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
+ DataField::BestShare => vec![(
|
||||
+ WEB_MINER_STATS,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/miner_stats/best_share"),
|
||||
+ tag: None,
|
||||
+ },
|
||||
+ )],
|
||||
DataField::TuningTarget => vec![
|
||||
(
|
||||
WEB_MINER_CONFIGURATION,
|
||||
@@ -548,7 +556,13 @@ impl GetUptime for BraiinsV2604 {
|
||||
}
|
||||
}
|
||||
|
||||
-impl GetBestShare for BraiinsV2604 {}
|
||||
+impl GetBestShare for BraiinsV2604 {
|
||||
+ fn parse_best_share(&self, data: &HashMap<DataField, Value>) -> Option<f64> {
|
||||
+ // Braiins OS reports the all-time best share at miner/stats -> miner_stats.best_share
|
||||
+ // (round 16 / G9). Large diffs may exceed f64 exactness but are fine for display.
|
||||
+ data.extract::<f64>(DataField::BestShare)
|
||||
+ }
|
||||
+}
|
||||
impl GetSessionBestShare for BraiinsV2604 {}
|
||||
|
||||
impl GetOperatingState for BraiinsV2604 {
|
||||
diff --git a/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs b/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs
|
||||
index aac39eb6..2d1331bf 100644
|
||||
--- a/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs
|
||||
+++ b/vendor/asic-rs-firmwares-luxminer/src/backends/v1/mod.rs
|
||||
@@ -445,6 +445,22 @@ impl GetDataLocations for LuxMinerV1 {
|
||||
tag: None,
|
||||
},
|
||||
)],
|
||||
+ DataField::BestShare => vec![(
|
||||
+ RPC_SUMMARY,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/SUMMARY/0/Best Share"),
|
||||
+ tag: None,
|
||||
+ },
|
||||
+ )],
|
||||
+ DataField::SessionBestShare => vec![(
|
||||
+ RPC_SUMMARY,
|
||||
+ DataExtractor {
|
||||
+ func: get_by_pointer,
|
||||
+ key: Some("/SUMMARY/0/Best Session Share"),
|
||||
+ tag: None,
|
||||
+ },
|
||||
+ )],
|
||||
DataField::Uptime => vec![(
|
||||
RPC_STATS,
|
||||
DataExtractor {
|
||||
@@ -888,8 +904,18 @@ impl GetUptime for LuxMinerV1 {
|
||||
}
|
||||
}
|
||||
|
||||
-impl GetBestShare for LuxMinerV1 {}
|
||||
-impl GetSessionBestShare for LuxMinerV1 {}
|
||||
+impl GetBestShare for LuxMinerV1 {
|
||||
+ fn parse_best_share(&self, data: &HashMap<DataField, Value>) -> Option<f64> {
|
||||
+ // LuxOS summary -> "Best Share" (all-time), round 16 / G9.
|
||||
+ data.extract::<f64>(DataField::BestShare)
|
||||
+ }
|
||||
+}
|
||||
+impl GetSessionBestShare for LuxMinerV1 {
|
||||
+ fn parse_session_best_share(&self, data: &HashMap<DataField, Value>) -> Option<f64> {
|
||||
+ // LuxOS summary -> "Best Session Share" (since boot), round 16 / G9.
|
||||
+ data.extract::<f64>(DataField::SessionBestShare)
|
||||
+ }
|
||||
+}
|
||||
|
||||
impl GetOperatingState for LuxMinerV1 {}
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
Subject: [PATCH 0014] luxminer: pool ops must be privileged (send session_id); add removepool
|
||||
|
||||
Round 16 / G13. The LuxOS pool write commands (addgroup, groupquota, removegroup,
|
||||
addpool, switchpool, enablepool, disablepool) were sent with privileged=false, so
|
||||
no session_id was included. That works on default units but FAILS with a
|
||||
"Missing session_id" error on password-set LuxOS units (every other LuxOS write --
|
||||
profileset/fanset/curtail/etc. -- is already privileged=true). Flip all seven pool
|
||||
ops to privileged=true so send_command prepends the logon session token, and add
|
||||
the missing rpc.removepool (privileged) for future incremental pool editing.
|
||||
|
||||
Verified no regression on a default corpus unit (10.4.1.60): set_pools_config still
|
||||
applies correctly via the new privileged path. The password-set failure path is a
|
||||
code-correct fix but needs a password-set LuxOS unit to reproduce/verify live.
|
||||
diff --git a/vendor/asic-rs-firmwares-luxminer/src/backends/v1/rpc.rs b/vendor/asic-rs-firmwares-luxminer/src/backends/v1/rpc.rs
|
||||
index 1afc686c..39d7ef63 100644
|
||||
--- a/vendor/asic-rs-firmwares-luxminer/src/backends/v1/rpc.rs
|
||||
+++ b/vendor/asic-rs-firmwares-luxminer/src/backends/v1/rpc.rs
|
||||
@@ -239,7 +239,7 @@ impl LUXMinerRPCAPI {
|
||||
pub async fn addgroup(&self, name: &str, quota: u32) -> anyhow::Result<Value> {
|
||||
self.send_command(
|
||||
"addgroup",
|
||||
- false,
|
||||
+ true,
|
||||
Some(Value::String(format!("{name},{quota}"))),
|
||||
)
|
||||
.await
|
||||
@@ -248,7 +248,7 @@ impl LUXMinerRPCAPI {
|
||||
pub async fn groupquota(&self, group_id: u32, quota: u32) -> anyhow::Result<Value> {
|
||||
self.send_command(
|
||||
"groupquota",
|
||||
- false,
|
||||
+ true,
|
||||
Some(Value::String(format!("{group_id},{quota}"))),
|
||||
)
|
||||
.await
|
||||
@@ -257,7 +257,7 @@ impl LUXMinerRPCAPI {
|
||||
pub async fn removegroup(&self, group_id: u32) -> anyhow::Result<Value> {
|
||||
self.send_command(
|
||||
"removegroup",
|
||||
- false,
|
||||
+ true,
|
||||
Some(Value::String(group_id.to_string())),
|
||||
)
|
||||
.await
|
||||
@@ -275,14 +275,14 @@ impl LUXMinerRPCAPI {
|
||||
params.push(group_id);
|
||||
}
|
||||
|
||||
- self.send_command("addpool", false, Some(Value::String(params.join(","))))
|
||||
+ self.send_command("addpool", true, Some(Value::String(params.join(","))))
|
||||
.await
|
||||
}
|
||||
|
||||
pub async fn switchpool(&self, pool_id: i32) -> anyhow::Result<Value> {
|
||||
self.send_command(
|
||||
"switchpool",
|
||||
- false,
|
||||
+ true,
|
||||
Some(Value::String(pool_id.to_string())),
|
||||
)
|
||||
.await
|
||||
@@ -291,7 +291,7 @@ impl LUXMinerRPCAPI {
|
||||
pub async fn enablepool(&self, pool_id: i32) -> anyhow::Result<Value> {
|
||||
self.send_command(
|
||||
"enablepool",
|
||||
- false,
|
||||
+ true,
|
||||
Some(Value::String(pool_id.to_string())),
|
||||
)
|
||||
.await
|
||||
@@ -300,7 +300,16 @@ impl LUXMinerRPCAPI {
|
||||
pub async fn disablepool(&self, pool_id: i32) -> anyhow::Result<Value> {
|
||||
self.send_command(
|
||||
"disablepool",
|
||||
- false,
|
||||
+ true,
|
||||
+ Some(Value::String(pool_id.to_string())),
|
||||
+ )
|
||||
+ .await
|
||||
+ }
|
||||
+
|
||||
+ pub async fn removepool(&self, pool_id: i32) -> anyhow::Result<Value> {
|
||||
+ self.send_command(
|
||||
+ "removepool",
|
||||
+ true,
|
||||
Some(Value::String(pool_id.to_string())),
|
||||
)
|
||||
.await
|
||||
@@ -0,0 +1,37 @@
|
||||
Subject: [PATCH 0015] braiins v26_04: treat an empty 2xx body as success (not a parse error)
|
||||
|
||||
Found live verifying change-password (round 17 B / G11). The BOS REST setters like
|
||||
PUT auth/password answer 2xx with an empty body; send_command tried
|
||||
response.json() on it, which fails, so change_password (which does `.is_ok()`)
|
||||
reported Ok(false) even though the password DID change. Read the body as text
|
||||
first: an empty body on a success status is Null (success), a non-empty body must
|
||||
still parse. Verified live on 10.4.1.27: change root->bftest2 now returns Ok(true),
|
||||
the new password authenticates, and restore -> root returns Ok(true).
|
||||
diff --git a/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs b/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs
|
||||
index 624eca4c..3e06b682 100644
|
||||
--- a/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs
|
||||
+++ b/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs
|
||||
@@ -57,11 +57,20 @@ impl WebAPIClient for BraiinsWebAPI {
|
||||
|
||||
let status = response.status();
|
||||
if status.is_success() {
|
||||
- let json_data = response
|
||||
- .json()
|
||||
+ // Some setters (e.g. PUT auth/password) answer 2xx with an empty or
|
||||
+ // non-JSON body. An empty body is success, not a parse error -- treat
|
||||
+ // it as Null so callers using `.is_ok()` don't read a real success as
|
||||
+ // failure. A non-empty body must still parse.
|
||||
+ let body = response
|
||||
+ .text()
|
||||
.await
|
||||
.map_err(|e| BraiinsError::ParseError(e.to_string()))?;
|
||||
- Ok(json_data)
|
||||
+ if body.trim().is_empty() {
|
||||
+ Ok(Value::Null)
|
||||
+ } else {
|
||||
+ Ok(serde_json::from_str(&body)
|
||||
+ .map_err(|e| BraiinsError::ParseError(e.to_string()))?)
|
||||
+ }
|
||||
} else {
|
||||
// The API reports why it rejected a request in the body.
|
||||
let status = status.as_u16();
|
||||
@@ -0,0 +1,62 @@
|
||||
Subject: [PATCH 0016] braiins v26_04: single-flight auth + defensive get_data timeout
|
||||
|
||||
Round 17 R4 support. Braiins get_data fans out to ~12 authenticated REST calls
|
||||
concurrently. Two hardening changes so a Braiins miner survives a busy scan:
|
||||
|
||||
- ensure_authenticated single-flights the login. Previously all ~12 concurrent
|
||||
commands could see no token and each POST /auth/login -- a thundering herd that
|
||||
doubled the connection load. Now the write lock is held across the login with a
|
||||
double-check, so exactly one call authenticates and the rest reuse the token.
|
||||
- The per-call timeout goes 5s -> 15s as defensive headroom (a healthy miner still
|
||||
answers well under a second) so a call queued behind a scan burst completes
|
||||
instead of dropping miner/stats.
|
||||
|
||||
Neither is the primary fix for the fleet-scan value dropout -- that is the
|
||||
app-side scan concurrency cap (scan::SCAN_CONCURRENCY_LIMIT = 128), which keeps
|
||||
the identification burst from starving these calls. These are the belt to that
|
||||
suspenders. Verified live: a 10.4.1.0/24 scan now populates both Braiins corpus
|
||||
miners (.27, .83) fully (watts, best-share, fw/control-board) and misses no
|
||||
responders.
|
||||
diff --git a/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs b/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs
|
||||
index 3e06b682..ae433d98 100644
|
||||
--- a/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs
|
||||
+++ b/vendor/asic-rs-firmwares-braiins/src/backends/v26_04/web.rs
|
||||
@@ -87,7 +87,13 @@ impl BraiinsWebAPI {
|
||||
client: OnceCell::new(),
|
||||
ip,
|
||||
port: 80,
|
||||
- timeout: Duration::from_secs(5),
|
||||
+ // Braiins get_data fans out to ~12 authenticated REST calls that run
|
||||
+ // concurrently. A healthy miner answers well under a second; the extra
|
||||
+ // headroom over the old 5 s is defensive so a call that queues behind a
|
||||
+ // scan burst still completes instead of dropping miner/stats
|
||||
+ // (hashrate/watts/best-share). The real fix for the fleet-scan dropout
|
||||
+ // is the app-side scan concurrency cap (see scan::SCAN_CONCURRENCY_LIMIT).
|
||||
+ timeout: Duration::from_secs(15),
|
||||
bearer_token: RwLock::new(None),
|
||||
auth,
|
||||
}
|
||||
@@ -122,13 +128,22 @@ impl BraiinsWebAPI {
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
+ // Single-flight the login: get_data fires ~12 commands concurrently, and
|
||||
+ // without this they would ALL see no token and each POST /auth/login (a
|
||||
+ // thundering herd that doubles the connection load and races under a
|
||||
+ // high-concurrency fleet scan, dropping most values). Hold the write lock
|
||||
+ // across the login so exactly one call authenticates and the rest reuse it.
|
||||
+ let mut guard = self.bearer_token.write().await;
|
||||
+ if guard.is_some() {
|
||||
+ return Ok(());
|
||||
+ }
|
||||
let token = match &self.auth {
|
||||
MinerAuth::TokenAuth(token) => token.expose_secret().to_string(),
|
||||
MinerAuth::UserAndPass(creds) => {
|
||||
self.authenticate(creds.password.expose_secret()).await?
|
||||
}
|
||||
};
|
||||
- *self.bearer_token.write().await = Some(token);
|
||||
+ *guard = Some(token);
|
||||
|
||||
Ok(())
|
||||
}
|
||||