Skip to content

Make mining a verified one-command path - #14

Open
adamtpang wants to merge 1 commit into
Quantus-Network:mainfrom
adamtpang:codex/one-command-mining-9-9
Open

Make mining a verified one-command path#14
adamtpang wants to merge 1 commit into
Quantus-Network:mainfrom
adamtpang:codex/one-command-mining-9-9

Conversation

@adamtpang

Copy link
Copy Markdown

Overview

Replace the current multi-decision mining setup with one verified Planck testnet route. A first-time user downloads the installer, verifies its checksum, runs ./quantus-mining.sh mine, enters the wallet recovery phrase only into a hidden local prompt, and receives one status contract.

This change does not claim mainnet support, a launch date, monetary rewards, or unpublished platform support.

Before and after

Area Before After
Release selection Node and miner resolved independent latest releases One machine-readable pair: node v0.10.0, miner v4.0.2, protocol quantus-miner/2
Download integrity Binaries installed without digest checks Every release asset must match its official GitHub SHA-256 digest before installation
Beginner path Several commands and resource, name, network, and version decisions One daily command, one hidden local recovery-phrase prompt, automatic conservative defaults
Success state Users inspect separate processes and logs status reports network, pair, node, sync, miner, hash rate, reward address, telemetry, and recovery action
Restart proof No explicit contract restart-check stops, restarts, and verifies both processes
Desktop app Draft page linked to the repository's generic latest release Public preview page with direct Windows, macOS, and Linux assets plus exact verification commands
AI handoff Mining skill only Copy Context includes the skill, pinned compatibility manifest, and full guide

What changed

  • Add static/mining-compatibility.json as the single supported Planck release manifest.
  • Pin official chain, miner, and desktop app URLs and SHA-256 digests.
  • Make mine, status, and restart-check the primary installer commands.
  • Fail closed on unsupported network, protocol, platform, URL, asset name, version, or checksum.
  • Keep the recovery phrase in a hidden local prompt and out of config, logs, command history, telemetry, and copied AI context.
  • Store the derived reward preimage in an owner-only file instead of the public configuration file.
  • Replace the mining guide with a three-step quick start, one AI prompt, one status contract, and one recovery action per failure.
  • Publish the desktop app as an explicitly limited preview with direct platform downloads.
  • Add automated manifest, platform, compatibility, checksum, redaction, command, prompt, and installer-byte tests.

Validation

  • bun run typecheck
  • bun test: 13 tests, 103 assertions, 0 failures
  • bun run build
  • Git Bash syntax check: bash -n static/scripts/quantus-mining.sh
  • Official GitHub release API comparison: all 17 release assets matched the manifest URLs and digests
  • Helium browser QA at desktop and 390 x 844 mobile viewports
  • Rendered routes, direct downloads, compatibility manifest, installer, checksum, and Copy Context verified
  • No page-wide horizontal overflow on either guide
  • git diff --check

The build completes with the repository's existing stale Browserslist-data warning and the existing vscode-languageserver-types dynamic-require warning.

Owner facts before merge

  1. A Quantus release owner should confirm v0.10.0 plus v4.0.2 as the supported pair. The current evidence is the official miner v4.0.0 release note requiring node v0.10.0+.
  2. Minimum supported Windows, macOS, and Linux versions are not published. The manifest says not-published instead of inventing values.
  3. The chain currently accepts --rewards-inner-hash only as a process argument. This patch protects the value at rest with owner-only permissions, but it remains visible to local process inspection while the node runs. A follow-up chain change should add --rewards-inner-hash-file or an equivalent secret-input mechanism.
  4. Quantus does not currently publish signed compatibility metadata. This patch verifies HTTPS-delivered metadata and official GitHub asset digests, but the manifest and installer checksum are not signed. A release owner should establish a signing key and signed manifest flow.
  5. Desktop app miner-v0.6.1 independently downloads the latest chain and miner releases and does not verify them. It remains a preview until it consumes the shared manifest and verifies every runtime download.
  6. The verified Windows route is WSL2. Native Windows remains on the desktop preview path.

Scope

This PR changes documentation, static release metadata, the existing installer, Copy Context, and tests. It does not merge, deploy, publish a release, run a real wallet, or change chain or miner binaries.

Pin one supported Planck node and miner pair in a machine-readable compatibility manifest.

Verify release checksums before installation, keep wallet recovery input local, add clear status and restart checks, and publish direct desktop preview downloads with platform verification commands.

Add automated compatibility, checksum, redaction, command, and documentation tests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant