docs: document wallet chain-read control methods - #71
Conversation
Extends the existing control.wallet.balance page into a full control.wallet.* reference covering the four open chain reads (balance, coins, peak, coinById) and the one token-gated write (broadcast) that dig-node's control plane now serves. Generalizes the -32040..-32043 error-code descriptions in error-codes.md and their source in scripts/dig-spec.mjs, which previously named only control.wallet.balance, to cover every control.wallet.* method. Co-Authored-By: Claude <noreply@anthropic.com>
e8444e9 to
552b838
Compare
HOLD — do not merge until
|
|
Converted to draft deliberately — this is a HOLD, not a problem with the PR. The content is clean and the checks are green. It is blocked on a sequencing fact, not a defect: it documents Merge order:
It was sitting CLEAN and non-draft, so the hold was purely a note somebody had to read and honour — the same conventional-not-structural shape the review gate flagged on #7 itself. Draft makes it unmergeable until step 2 lands. Mark ready then; no rebase or content change is expected. |
|
Merge-order constraint — this PR must land AFTER dig-node serves This PR documents Merging this first would publish user-facing documentation for a method that answers Order: contract 0.7.0 publishes → dig-node #201 merges and releases → this PR merges. The PR is CLEAN and green; nothing here needs changing. It is purely a sequencing hold. Posted from the dig-node lane so the constraint survives outside a session's context. |
What changed
Closes the documentation gap in #2392: dig-node's control plane now serves five
control.wallet.*methods, but onlycontrol.wallet.balancewas documented.docs/run-a-node/manage.md— restructured the singlecontrol.wallet.balancesection into acontrol.wallet.*overview (open-read vs token-gated split, the "never signs" invariant) followed by five subsections:balance(unchanged content),coins,peak,coinById,broadcast. Each documents its request/result shape, field table, and the load-bearing semantics from the spec (coins: []vs an unreachable-chain error,peak_height: nullas unknown-not-zero,coinById's ability to see a spent coin,broadcast's accepted-vs-confirmed distinction).docs/support/error-codes.md— generalized the-32040..-32043row descriptions and links from "wallet-balance read codes" to cover allcontrol.wallet.*methods; no codes added or removed.scripts/dig-spec.mjs— generalized the matchingmeaningstrings feedingstatic/error-codes.jsonso the machine-readable catalog and the prose stay in sync.static/error-codes.json— regenerated (npm run machine-specs); the drift gate passed (65 codes, 4 surfaces — same counts as before, wording only).package.json— version bump0.15.0→0.16.0(minor: new documented capability).Saturation search
Searched the whole docs tree for
control.wallet/wallet.balance/control.*summaries. No other page lists or summarizes individual control methods —docs/rpc/methods.md'sdig.methodsexample is the network-profile method list and doesn't includecontrol.*(admin-plane, not network profile), so it did not need updating.docs/run-a-node/manage.md's owncontrol.*bullet summary (status/cache/peers) now has a fourth bullet forwallet.Verified
node scripts/gen-machine-specs.mjs— drift gate passed, no code-set changes.npm run build— full Docusaurus build (all 15 locales) completed with exit 0, no broken-link errors introduced.Blast radius
Docs-only change, one repo (
docs.dig.net), no code/API touched. The only "existing claim" I checked for mismatch against the given method shapes: the priorcontrol.wallet.balancedoc's error table andsource/synced/peak_heightsemantics — carried forward unchanged, no discrepancy found.Co-Authored-By: Claude noreply@anthropic.com