docs(run-a-node): document which source answered a wallet balance read - #68
Merged
Conversation
Refs dig_ecosystem#2233 Co-Authored-By: Claude <noreply@anthropic.com>
MichaelTaylor3d
commented
Aug 6, 2026
MichaelTaylor3d
left a comment
Contributor
Author
There was a problem hiding this comment.
VERDICT: PASS — reviewed at 84ec5461fc861848b1765ec6d87855771b0dcc23.
Verified:
- Describes shipped behaviour, not intent. The sample, the field table and the new subsection match dig-node#189's actual arms:
"fallback"⇒synced:falseandpeak_height:null,"db"⇒ the replica's peak. Thesourcerow correctly documentsnullas "a node too old to say", which matches the contract crate'sOptiontri-state rather than inventing a default. - §4.3 clean. No reference to
SYSTEM.md/SPEC.md/CLAUDE.md/ internal tickets; no drift commentary; audience-1 voice throughout. The consequence a person actually cares about — the address you asked about was sent to that service — leads, which is the right ordering for this audience. - No stale locale copy. I re-derived the claim independently:
peak_heightappears in exactly one file tree-wide (docs/run-a-node/manage.md), and the 13 localisedmanage.mdfiles are the shorter, pre-balance-section version (46 lines vs 130) with no balance content at all — so nothing localized goes stale. Their incompleteness is a pre-existing gap, not this PR's. - The claim in
point-a-consumer.md:46("your addresses aren't disclosed to a public operator") does become checkable by the reader for the first time, as the body says. --shortstatmatches--ignore-cr-at-eol(17/4). 0.13.0 → 0.14.0 is right for new documented capability.
No findings. Nothing open from me on this PR.
One cross-PR heads-up, not a change request here: I have raised a gating item on dig-node#189 about the tier tracing event being debug! under an info default filter. It does not affect any sentence on this page — nothing here promises the tier appears in the log.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs half of dig_ecosystem#2233 (S1 of the #2232 sync plan). Node half: DIG-Network/dig-node#189. Contract half: DIG-Network/dig-node-control-interface#5.
control.wallet.balancenow returns asourcefield, and itssynced/peak_heightfields changed meaning: they describe the source that answered, not the node in general.docs/run-a-node/manage.mddescribed the old behaviour, which is a bug per §4.3.Updated: the result JSON sample, the field table, and a new short "Where the answer came from" subsection written for audience 1 (node operators) — plain language, no protocol jargon, leading with the consequence that matters to a person: a
"fallback"answer means their address was sent to a public service.This also makes an existing claim in
point-a-consumer.md— that reading from your own node is more private because "your addresses aren't disclosed to a public operator" — checkable by the reader rather than something they have to take on trust.No i18n changes needed:
peak_heightappears only in the English tree (grep -rl peak_height i18n/is empty), so no locale copy is being left stale.0.13.0 → 0.14.0 (minor: new documented capability).
git diff --shortstatand--ignore-cr-at-eolagree (17/4), so no CRLF flip.