wiki: correct the listreceivedbyaddress description in the RPC reference - #454
Open
jamescowens wants to merge 1 commit into
Open
Conversation
listreceivedbyaddress does not return "the balance of each address": it tallies received payments only (no spending subtracted, no staking rewards), and only for addresses with an address book entry -- change addresses are not listed. This description sent a tester down a long debugging path on Discord (#testnet, Jul 2026) trying to reconcile it with listunspent/listaddressgroupings, which are the commands that actually show where funds sit. Describe what the command really does and point balance questions at the right tools. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
The RPC reference described
listreceivedbyaddressas "Returns a list of the balance of each address". It does not return balances: it tallies received payments only — spending is not subtracted, staking rewards are never counted, and only addresses with an address book entry are listed, so change addresses are invisible to it.This exact sentence sent a tester (QuaXeros) down a long debugging path on Discord #testnet (Jul 2026) trying to reconcile the command's output with
listunspent/listaddressgroupings— which are the commands that actually show where funds currently sit.This PR rewrites the entry to say what the command really does, points balance questions at the right tools, and fixes the parameter descriptions that repeated the "balance" framing. Companion effort: sharpened help text for the same RPCs in the client itself (Gridcoin-Research, forthcoming), and gridcoin-community/Gridcoin-Research#3188 which addresses the underlying surprise for externally-paid unbooked addresses.
🤖 Generated with Claude Code