From 860fc8886a60c03cd59eb46a3dc030a7ba3ac6a6 Mon Sep 17 00:00:00 2001 From: Kris Nuttycombe Date: Tue, 15 Mar 2022 16:37:59 -0600 Subject: [PATCH] Update documentation of z_importviewingkey and z_exportviewingkey to address unified keys. --- src/wallet/rpcdump.cpp | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/wallet/rpcdump.cpp b/src/wallet/rpcdump.cpp index 5374ff7e2..7688573bd 100644 --- a/src/wallet/rpcdump.cpp +++ b/src/wallet/rpcdump.cpp @@ -91,7 +91,7 @@ UniValue importprivkey(const UniValue& params, bool fHelp) "1. \"zcashprivkey\" (string, required) The private key (see dumpprivkey)\n" "2. \"label\" (string, optional, default=\"\") An optional label\n" "3. rescan (boolean, optional, default=true) Rescan the wallet for transactions\n" - "\nNote: This call can take minutes to complete if rescan is true.\n" + "\nNote: This call can take a long time to complete if rescan is true.\n" "\nExamples:\n" "\nDump a private key\n" + HelpExampleCli("dumpprivkey", "\"myaddress\"") + @@ -202,7 +202,7 @@ UniValue importaddress(const UniValue& params, bool fHelp) "2. \"label\" (string, optional, default=\"\") An optional label\n" "3. rescan (boolean, optional, default=true) Rescan the wallet for transactions\n" "4. p2sh (boolean, optional, default=false) Add the P2SH version of the script as well\n" - "\nNote: This call can take minutes to complete if rescan is true.\n" + "\nNote: This call can take a long time to complete if rescan is true.\n" "If you have the full public key, you should call importpubkey instead of this.\n" "\nNote: If you import a non-standard raw script in hex form, outputs sending to it will be treated\n" "as change, and not show up in many RPCs.\n" @@ -271,7 +271,7 @@ UniValue importpubkey(const UniValue& params, bool fHelp) "1. \"pubkey\" (string, required) The hex-encoded public key\n" "2. \"label\" (string, optional, default=\"\") An optional label\n" "3. rescan (boolean, optional, default=true) Rescan the wallet for transactions\n" - "\nNote: This call can take minutes to complete if rescan is true.\n" + "\nNote: This call can take a long time to complete if rescan is true.\n" "\nExamples:\n" "\nImport a public key with rescan\n" + HelpExampleCli("importpubkey", "\"mypubkey\"") + @@ -716,7 +716,7 @@ UniValue z_importkey(const UniValue& params, bool fHelp) "1. \"zkey\" (string, required) The zkey (see z_exportkey)\n" "2. rescan (string, optional, default=\"whenkeyisnew\") Rescan the wallet for transactions - can be \"yes\", \"no\" or \"whenkeyisnew\"\n" "3. startHeight (numeric, optional, default=0) Block height to start rescan from\n" - "\nNote: This call can take minutes to complete if rescan is true.\n" + "\nNote: This call can take a long time to complete if rescan is true.\n" "\nResult:\n" "{\n" " \"type\" : \"xxxx\", (string) \"sprout\" or \"sapling\"\n" @@ -822,7 +822,7 @@ UniValue z_importviewingkey(const UniValue& params, bool fHelp) "1. \"vkey\" (string, required) The viewing key (see z_exportviewingkey)\n" "2. rescan (string, optional, default=\"whenkeyisnew\") Rescan the wallet for transactions - can be \"yes\", \"no\" or \"whenkeyisnew\"\n" "3. startHeight (numeric, optional, default=0) Block height to start rescan from\n" - "\nNote: This call can take minutes to complete if rescan is true.\n" + "\nNote: This call can take a long time to complete if rescan is true. Import of Unified viewing keys is not yet supported.\n" "\nResult:\n" "{\n" " \"type\" : \"xxxx\", (string) \"sprout\" or \"sapling\"\n" @@ -990,8 +990,10 @@ UniValue z_exportviewingkey(const UniValue& params, bool fHelp) if (fHelp || params.size() != 1) throw runtime_error( "z_exportviewingkey \"zaddr\"\n" - "\nReveals the viewing key corresponding to 'zaddr'.\n" - "Then the z_importviewingkey can be used with this output\n" + "\nReturns the full viewing key corresponding to 'zaddr' in the format specified by\n" + "https://zips.z.cash/protocol/protocol.pdf#addressandkeyencoding.\n" + "z_importviewingkey can be used to import Sprout and Sapling exported in this format;\n" + "import of unified viewing keys is not yet supported.\n" "\nArguments:\n" "1. \"zaddr\" (string, required) The zaddr for the viewing key\n" "\nResult:\n"