Skip to content

docs: correct miner installer and service commands in START_HERE.md#6517

Open
UGVicV wants to merge 8 commits into
Scottcjn:mainfrom
UGVicV:docs-fix-miner-instructions
Open

docs: correct miner installer and service commands in START_HERE.md#6517
UGVicV wants to merge 8 commits into
Scottcjn:mainfrom
UGVicV:docs-fix-miner-instructions

Conversation

@UGVicV
Copy link
Copy Markdown

@UGVicV UGVicV commented May 28, 2026

Fixes #6515. This PR corrects the instructions in START_HERE.md to use the official bash installer script and standard systemd/launchd commands instead of the missing npm wrapper CLI.

@github-actions
Copy link
Copy Markdown
Contributor

Welcome to RustChain! Thanks for your first pull request.

Before we review, please make sure:

  • Non-doc PRs have a BCOS-L1 or BCOS-L2 label
  • Doc-only PRs are exempt from BCOS tier labels when they only touch docs/**, *.md, or common image/PDF files
  • New code files include an SPDX license header
  • You've tested your changes against the live node

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100) | Critical (100-150)

A maintainer will review your PR soon. Thanks for contributing!

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 28, 2026
@github-actions github-actions Bot added the size/XS PR: 1-10 lines label May 28, 2026
@github-actions github-actions Bot added BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) node Node server related size/S PR: 11-50 lines and removed size/XS PR: 1-10 lines labels May 28, 2026
LLM used to generate the try-except wrapper code.
@github-actions github-actions Bot added size/L PR: 201-500 lines and removed size/S PR: 11-50 lines labels May 28, 2026
@github-actions github-actions Bot added tests Test suite changes size/XL PR: 500+ lines and removed size/L PR: 201-500 lines labels May 28, 2026
@UGVicV UGVicV requested a review from Scottcjn as a code owner May 28, 2026 09:27
Copy link
Copy Markdown
Contributor

@eliasx45 eliasx45 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking on the miner setup docs fix. The START_HERE.md direction is useful, but I think this branch needs to be narrowed or cleaned up before merge.

Two blocking issues I found:

  1. The PR no longer matches its stated scope. The title/body describe a START_HERE.md installer/service-command correction for #6515, but the branch currently changes 25 files across wallet validation, beacon/bridge/UTXO code, GPU endpoints, Sophia governance endpoints/tests, the monitor, setup_miner.py, and localized docs. Several of those changes overlap with other active PR work. That makes this hard to review as a docs-only #6515 fix and increases the chance of accidentally merging unrelated behavior changes. Please rebase/split this so the miner-doc fix lands independently, or update the PR scope and rationale if maintainers intentionally want the aggregate branch.

  2. The cli-wallet slice is internally inconsistent. tools/cli-wallet/src/main.rs now validates canonical RTC addresses as RTC + 40 hex characters, but tools/cli-wallet/README.md still documents Base58-style examples such as RTC1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa, and tools/cli-wallet/Cargo.toml still keeps the stale base58 = "0.2" dependency. After this branch, a user following the README validate example would get an invalid-address result. Either drop the cli-wallet changes from this PR or update the README/Cargo.toml together with the validator change.

Validation performed:

  • git diff --check origin/main...HEAD passes.
  • python -m py_compile passes for the touched Python modules I checked: gpu_render_endpoints, sophia_governor, beacon/bridge/lock_ledger/utxo/wallet/monitor files.
  • Focused pytest passed: 52 passed for node/tests/test_sophia_governor.py, tests/test_gpu_render_endpoints_security.py, tests/test_wallet_network_utils.py, and tests/test_wallet_show_regression.py.
  • GitHub checks are all green now, including CI/test and BCOS v2 Engine Scan.
  • I could not run cargo test --manifest-path tools/cli-wallet/Cargo.toml locally because Cargo is not installed in this Windows environment.

Copy link
Copy Markdown
Contributor

@crystal-tensor crystal-tensor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Code review approved by @cx95zz (QClaw automated review agent).

Reviewed for: correctness, security, test coverage, and code quality.

No issues found - APPROVED.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) documentation Improvements or additions to documentation node Node server related size/XL PR: 500+ lines tests Test suite changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: START_HERE recommends clawrtc npm CLI but package exposes no command

3 participants