feat: upgradetohd return string with futher instructions instead bool

knst · knst · commit 960afcf77f35 · 2025-08-08T13:50:29.000+07:00
diff --git a/src/wallet/rpc/wallet.cpp b/src/wallet/rpc/wallet.cpp
@@ -354,9 +354,7 @@ static RPCHelpMan upgradetohd()
             {"walletpassphrase", RPCArg::Type::STR, RPCArg::Default{""}, "If your wallet is encrypted you must have your wallet passphrase here. If your wallet is not encrypted, specifying wallet passphrase will trigger wallet encryption."},
             {"rescan", RPCArg::Type::BOOL, RPCArg::DefaultHint{"false if mnemonic is empty"}, "Whether to rescan the blockchain for missing transactions or not"},
         },
-        RPCResult{
-            RPCResult::Type::BOOL, "", "true if successful"
-        },
+        RPCResult{RPCResult::Type::STR, "", "A string with further instructions"},
         RPCExamples{
             HelpExampleCli("upgradetohd", "")
     + HelpExampleCli("upgradetohd", "\"mnemonicword1 ... mnemonicwordN\"")
@@ -370,7 +368,7 @@ static RPCHelpMan upgradetohd()
     if (!pwallet) return NullUniValue;
 
     bool generate_mnemonic = request.params[0].isNull() || request.params[0].get_str().empty();
-
+    bool mnemonic_passphrase_has_null{false};
     {
         LOCK(pwallet->cs_wallet);
 
@@ -395,6 +393,7 @@ static RPCHelpMan upgradetohd()
         mnemonic_passphrase.reserve(256);
         if (!request.params[1].isNull()) {
             mnemonic_passphrase = std::string_view{request.params[1].get_str()};
+            mnemonic_passphrase_has_null = (mnemonic_passphrase.find('\0') != std::string::npos);
         }
 
         // TODO: breaking changes kept for v21!
@@ -490,7 +489,17 @@ static RPCHelpMan upgradetohd()
         }
     }
 
-    return true;
+    // Check if the passphrase has a null character (see #27067 for details)
+    if (!mnemonic_passphrase_has_null) {
+        return "Make sure that you have backup of your mnemonic.";
+    } else {
+        return "Make sure that you have backup of your mnemonic. "
+               "Your mnemonic passphrase contains a null character (ie - a zero byte). "
+               "If the passphrase was created with a version of this software prior to 23.0, "
+               "please try again with only the characters up to — but not including — "
+               "the first null character. If this is successful, please set a new "
+               "passphrase to avoid this issue in the future.";
+    }
 },
     };
 }
diff --git a/test/functional/wallet_upgradetohd.py b/test/functional/wallet_upgradetohd.py
@@ -243,7 +243,8 @@ def run_test(self):
 
         node.createwallet("wallet-12", blank=True)
         w12 = node.get_wallet_rpc("wallet-12")
-        w12.upgradetohd(custom_mnemonic, "custom-passphrase")
+        ret = w12.upgradetohd(custom_mnemonic, "custom-passphrase")
+        assert_equal(ret, "Make sure that you have backup of your mnemonic.")
         assert_equal(get_mnemonic(w12)[0], custom_mnemonic)
         assert_equal(get_mnemonic(w12)[1], "custom-passphrase")
         assert_equal(12, w12.getbalance())
@@ -252,7 +253,8 @@ def run_test(self):
         self.log.info("Check if null character at the end of mnemonic-passphrase matters")
         node.createwallet("wallet-null", blank=True)
         w_null = node.get_wallet_rpc("wallet-null")
-        w_null.upgradetohd(custom_mnemonic, "custom-passphrase\0")
+        ret = w_null.upgradetohd(custom_mnemonic, "custom-passphrase\0")
+        assert_equal(ret, "Make sure that you have backup of your mnemonic. Your mnemonic passphrase contains a null character (ie - a zero byte). If the passphrase was created with a version of this software prior to 23.0, please try again with only the characters up to — but not including — the first null character. If this is successful, please set a new passphrase to avoid this issue in the future.")
         assert_equal(0, w_null.getbalance())
         assert_equal(get_mnemonic(w_null)[1], "custom-passphrase\0")
         w_null.unloadwallet()
diff --git a/test/functional/wallet_upgradewallet.py b/test/functional/wallet_upgradewallet.py
@@ -169,7 +169,7 @@ def copy_non_hd():
         self.test_upgradewallet(wallet, previous_version=61000, expected_version=120200, requested_version=169900)
         # after conversion master key hash should not be present yet
         assert 'hdchainid' not in wallet.getwalletinfo()
-        assert_equal(wallet.upgradetohd(), True)
+        assert_equal(wallet.upgradetohd(), "Make sure that you have backup of your mnemonic.")
         new_version = wallet.getwalletinfo()["walletversion"]
         assert_equal(new_version, 120200)
         assert_is_hex_string(wallet.getwalletinfo()['hdchainid'])
