Clarify documentation of z_getbalanceforviewingkey for Sprout viewing keys.

This commit is contained in:
Kris Nuttycombe 2022-02-09 17:03:24 -07:00
parent bf79be2b57
commit d24a41496a
2 changed files with 5 additions and 2 deletions

View File

@ -48,8 +48,10 @@ New RPC Methods
process table; `zcashd-wallet-tool` is specifically provided to avoid this
problem.
- 'z_getbalanceforviewingkey' This newly created API allows a user to obtain
balance information for funds visible to a Sprout, Sapling, or Unified full
viewing key.
balance information for funds visible to a Sapling or Unified full
viewing key; if a Sprout viewing key is provided, this method allows
retrieval of the balance only in the case that the wallet controls the
corresponding spending key.
RPC Changes
-----------

View File

@ -3627,6 +3627,7 @@ UniValue z_getbalanceforviewingkey(const UniValue& params, bool fHelp)
throw runtime_error(
"z_getbalanceforviewingkey \"fvk\" ( minconf )\n"
"\nReturns the per-pool balances viewable by a full viewing key known to the node's wallet."
"\nSprout viewing keys may be used only if the wallet controls the corresponding spending key."
"\nArguments:\n"
"1. \"fvk\" (string) The selected full viewing key.\n"
"2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.\n"