Add menu option to migrate a wallet #738

achow101 · 2023-06-13T19:06:43Z

GUI users need to be able to migrate wallets without going to the RPC console.

DrahtBot · 2023-06-13T19:06:46Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	jarolrod, pablomartin4btc, hebasto
Concept ACK	S3RK, kristapsk, johnny9, D33r-Gee

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Conflicts

No conflicts as of last run.

src/wallet/interfaces.cpp

hebasto · 2023-06-14T09:30:09Z

Usually, we submit changes to non-qt subdirectory, i.e., the first commit of this PR, to the main repo, no?

maflcko · 2023-06-14T09:38:13Z

Usually, we submit changes to non-qt subdirectory, i.e., the first commit of this PR, to the main repo, no?

I don't think this rule applies to interface changes that only affect the gui. Otherwise, it just seems like extra work for reviewers and authors to artificially rip stuff apart for no good reason, with the extra risk of ending up merging just one ripped-off half, but not the other?

hebasto · 2023-06-14T09:40:28Z

Usually, we submit changes to non-qt subdirectory, i.e., the first commit of this PR, to the main repo, no?

I don't think this rule applies to interface changes that only affect the gui. Otherwise, it just seems like extra work for reviewers and authors to artificially rip stuff apart for no good reason, with the extra risk of ending up merging just one ripped-off half, but not the other?

I agree. It would be better to just document this case for further references.

hebasto · 2023-06-14T09:40:46Z

Concept ACK.

hebasto · 2023-06-14T09:41:34Z

cc @furszy @ryanofsky @S3RK

src/qt/walletcontroller.cpp

S3RK · 2023-06-19T07:31:24Z

Concept ACK

Not qualified to review GUI code, but agree it's a good idea to show migration option in GUI.

kristapsk · 2023-06-19T18:24:16Z

Concept ACK

jarolrod

Concept ACK, important feature

src/qt/walletcontroller.cpp

jarolrod · 2023-06-22T23:01:14Z

src/qt/walletcontroller.cpp

+    box.setWindowTitle(tr("Migrate wallet"));
+    box.setText(tr("Are you sure you wish to migrate the wallet <i>%1</i>?").arg(GUIUtil::HtmlEscape(wallet_model->getDisplayName())));
+    box.setInformativeText(tr("Migrating the wallet will convert this wallet to one or more descriptor wallets. A new wallet backup will need to be made.\n"
+                "If this wallet contains any watchonly those scripts, a new wallet will be created which contains those watchonly scripts.\n"


I do think this is quite wordy, and maybe more information than is needed. But, no need to reduce the amount of information here.

I know that for some users, they continue to use the Bitcoin Core GUI because their wallet was generated with it in some early version, and they are scared to use anything else but that. So, migrating can be a scary task.

When implementing this functionality for the gui-qml we'd probably make this less intimidating, perhaps as a wizard, and with more interaction/feedback with the process. CC @GBKS @mouxdesign

src/qt/walletcontroller.cpp

johnny9

Concept ACK. Very useful feature.

Wallet migration doesn't work for me if I have a legacy sqlite wallet. Unsure if the assumption is that this only works with a bdb legacy wallet.

src/qt/walletcontroller.cpp

AskPassphraseDialog has an optional parameter for the caller to get the passphrase. Make this available for Unlocking.

jarolrod · 2023-06-24T02:00:35Z

src/interfaces/wallet.h

@@ -423,6 +427,15 @@ struct WalletTxOut
    bool is_spent = false;
 };

+//! Migrated wallet info
+struct WalletMigrationResult
+{


we seem to use this style now, although it's not officially documented, so only nit

diff --git a/src/interfaces/wallet.h b/src/interfaces/wallet.h index 54eb720d0..d6a92cba7 100644 --- a/src/interfaces/wallet.h +++ b/src/interfaces/wallet.h @@ -428,8 +428,7 @@ struct WalletTxOut }; //! Migrated wallet info -struct WalletMigrationResult -{ +struct WalletMigrationResult { std::unique_ptr<Wallet> wallet; std::optional<std::string> watchonly_wallet_name; std::optional<std::string> solvables_wallet_name;

jarolrod · 2023-06-24T02:10:45Z

src/qt/walletcontroller.cpp

+                "The migration process will create a backup of the wallet before migrating. This backup file will be named "
+                "<wallet name>-<timestamp>.legacy.bak and can be found in the directory for this wallet. In the event of "
+                "an incorrect migration, the backup can be restored with the \"Restore Wallet\" functionality."));
+    box.setStandardButtons(QMessageBox::Yes|QMessageBox::Cancel);


nit

Suggested change

box.setStandardButtons(QMessageBox::Yes|QMessageBox::Cancel);

box.setStandardButtons(QMessageBox::Yes | QMessageBox::Cancel);

jarolrod · 2023-06-24T03:36:46Z

src/qt/walletcontroller.cpp

+    QMessageBox box(m_parent_widget);
+    box.setWindowTitle(tr("Migrate wallet"));
+    box.setText(tr("Are you sure you wish to migrate the wallet <i>%1</i>?").arg(GUIUtil::HtmlEscape(wallet_model->getDisplayName())));
+    box.setInformativeText(tr("Migrating the wallet will convert this wallet to one or more descriptor wallets. A new wallet backup will need to be made.\n"


Confirmed that all the new strings introduced here are nicely transferred over to be translated after running make translate

While not a blocker; the longer I look at this, the more I think it can be slimmed down. Will have another look tomorrow.

At least this is a chunky boy to translate, and will need a good translator comment:

<message> <location line="+1"/> <source>Migrating the wallet will convert this wallet to one or more descriptor wallets. A new wallet backup will need to be made. If this wallet contains any watchonly scripts, a new wallet will be created which contains those watchonly scripts. If this wallet contains any solvable but not watched scripts, a different and new wallet will be created which contains those scripts. The migration process will create a backup of the wallet before migrating. This backup file will be named <wallet name>-<timestamp>.legacy.bak and can be found in the directory for this wallet. In the event of an incorrect migration, the backup can be restored with the "Restore Wallet" functionality.</source> <translation type="unfinished"></translation> </message>

D33r-Gee

tested ACK on WSL Ubuntu 22.04
Migrated a few test wallets using the GUI on regtest, both encrypted and not-encrypted wallet yelled successful results.

jarolrod

ACK 48aae2c

This introduces the functionality as promised, works well, and didn't have any issues with legacy wallets + watch only addrs.

Improving the text and it's translatability to can occur in a follow-up.

pablomartin4btc

tACK 48aae2c

Very nice feature.

The menu option is disabled correctly if the selected wallet is not a Legacy one:

I had to ./configure --with-dbd in order to create a Legacy wallet first:

Not related with this PR: Do I need to use an older version to make it "portable"? It's referring to the backup of a legacy wallet or the copy of the files?

And ofc this is something we already saw in previous versions of bitcoin-qt before the "Descriptor Wallet" became checked by default and disabled so user is forced to use descriptor instead of legacy wallets:

Once a Legacy wallet is selected we can see the new menu option "Migrate Wallet":

Regarding the long message, perhaps can be restructured a bit with some bullets points?

Perhaps as a follow-up we can show a proper progress being updated (we have already these open issues related with that: #651, #679):

It works as expected and I was able to restore the migrated wallet successfully.

One more detail I noticed is that the migration process ends up saving a .bak extension file, when I wanted to try the restore of it, I had to change that extension to .dat, otherwise it won't be seen by the open/ restore file dialog as there's only one type of file possible in the bottom right combo-box:

Should we add another type there or perhaps set the migrated file extension as .dat too? The filename itself is automatically defined, should we give the user the option to name it instead?

pablomartin4btc · 2023-09-20T14:40:55Z

src/qt/askpassphrasedialog.cpp

+                if (m_passphrase_out) {
+                    m_passphrase_out->assign(oldpass);
+                }


nit:

Suggested change

if (m_passphrase_out) {

m_passphrase_out->assign(oldpass);

}

if (m_passphrase_out) m_passphrase_out->assign(oldpass);

pablomartin4btc · 2023-09-20T18:17:13Z

src/qt/walletcontroller.cpp

+            m_success_message = tr("The wallet '%1' was migrated successfully.").arg(GUIUtil::HtmlEscape(res->wallet->getWalletName()));
+            if (res->watchonly_wallet_name) {
+                m_success_message += tr(" Watchonly scripts have been migrated to a new wallet named '%1'.").arg(GUIUtil::HtmlEscape(res->watchonly_wallet_name.value()));
+            }
+            if (res->solvables_wallet_name) {
+                m_success_message += tr(" Solvable but not watched scripts have been migrated to a new wallet named '%1'.").arg(GUIUtil::HtmlEscape(res->solvables_wallet_name.value()));
+            }


Perhaps we can refactor this piece a bit, maybe extracting the message building to other functions?

hebasto

ACK 48aae2c

DrahtBot added the CI failed label Jun 13, 2023

maflcko reviewed Jun 13, 2023

View reviewed changes

src/wallet/interfaces.cpp Outdated Show resolved Hide resolved

interfaces, wallet: Expose migrate wallet

5b3a85b

achow101 force-pushed the migrate-wallet-gui branch from f7edbc5 to 0600351 Compare June 13, 2023 23:05

DrahtBot mentioned this pull request Jun 14, 2023

wallet: Migrate legacy wallets to descriptor wallets without requiring BDB bitcoin/bitcoin#26596

Merged

hebasto added the Wallet label Jun 14, 2023

S3RK reviewed Jun 19, 2023

View reviewed changes

src/qt/walletcontroller.cpp Outdated Show resolved Hide resolved

achow101 force-pushed the migrate-wallet-gui branch from 0600351 to c574e72 Compare June 19, 2023 15:23

DrahtBot removed the CI failed label Jun 19, 2023

jarolrod reviewed Jun 22, 2023

View reviewed changes

johnny9 reviewed Jun 23, 2023

View reviewed changes

src/qt/walletcontroller.cpp Show resolved Hide resolved

achow101 added 2 commits June 23, 2023 14:24

gui: Optionally return passphrase after unlocking

577be88

AskPassphraseDialog has an optional parameter for the caller to get the passphrase. Make this available for Unlocking.

gui: Add File > Migrate Wallet

48aae2c

achow101 force-pushed the migrate-wallet-gui branch from c574e72 to 48aae2c Compare June 23, 2023 18:24

jarolrod reviewed Jun 24, 2023

View reviewed changes

D33r-Gee reviewed Jun 26, 2023

View reviewed changes

jarolrod approved these changes Jul 5, 2023

View reviewed changes

This was referenced Jul 22, 2023

refactor: Use util::Result class for wallet loading bitcoin/bitcoin#25722

Draft

Open fully encrypted wallets #747

Closed

DrahtBot added CI failed and removed CI failed labels Aug 17, 2023

DrahtBot added the CI failed label Aug 31, 2023

DrahtBot removed the CI failed label Sep 4, 2023

pablomartin4btc reviewed Sep 20, 2023

View reviewed changes

hebasto approved these changes Sep 20, 2023

View reviewed changes

hebasto merged commit 1d4846a into bitcoin-core:master Sep 20, 2023
13 of 15 checks passed

ryanofsky mentioned this pull request Sep 21, 2023

Multiprocess bitcoin bitcoin/bitcoin#10102

Draft

Frank-GER pushed a commit to syscoin/syscoin that referenced this pull request Sep 25, 2023

Merge bitcoin-core/gui#738: Add menu option to migrate a wallet

64ed740

sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Sep 26, 2023

Merge bitcoin-core/gui#738: Add menu option to migrate a wallet

56be215

hebasto mentioned this pull request Jul 14, 2024

Migrate legacy wallets that are not loaded #824

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add menu option to migrate a wallet #738

Add menu option to migrate a wallet #738

achow101 commented Jun 13, 2023

DrahtBot commented Jun 13, 2023 •

edited

Loading

hebasto commented Jun 14, 2023

maflcko commented Jun 14, 2023

hebasto commented Jun 14, 2023

hebasto commented Jun 14, 2023

hebasto commented Jun 14, 2023

S3RK commented Jun 19, 2023

kristapsk commented Jun 19, 2023

jarolrod left a comment

jarolrod Jun 22, 2023

johnny9 left a comment

jarolrod Jun 24, 2023

jarolrod Jun 24, 2023

jarolrod Jun 24, 2023

D33r-Gee left a comment

jarolrod left a comment

pablomartin4btc left a comment

pablomartin4btc Sep 20, 2023

pablomartin4btc Sep 20, 2023

hebasto left a comment

	box.setStandardButtons(QMessageBox::Yes\|QMessageBox::Cancel);
	box.setStandardButtons(QMessageBox::Yes \| QMessageBox::Cancel);

Add menu option to migrate a wallet #738

Add menu option to migrate a wallet #738

Conversation

achow101 commented Jun 13, 2023

DrahtBot commented Jun 13, 2023 • edited Loading

Reviews

Conflicts

hebasto commented Jun 14, 2023

maflcko commented Jun 14, 2023

hebasto commented Jun 14, 2023

hebasto commented Jun 14, 2023

hebasto commented Jun 14, 2023

S3RK commented Jun 19, 2023

kristapsk commented Jun 19, 2023

jarolrod left a comment

Choose a reason for hiding this comment

jarolrod Jun 22, 2023

Choose a reason for hiding this comment

johnny9 left a comment

Choose a reason for hiding this comment

jarolrod Jun 24, 2023

Choose a reason for hiding this comment

jarolrod Jun 24, 2023

Choose a reason for hiding this comment

jarolrod Jun 24, 2023

Choose a reason for hiding this comment

D33r-Gee left a comment

Choose a reason for hiding this comment

jarolrod left a comment

Choose a reason for hiding this comment

pablomartin4btc left a comment

Choose a reason for hiding this comment

pablomartin4btc Sep 20, 2023

Choose a reason for hiding this comment

pablomartin4btc Sep 20, 2023

Choose a reason for hiding this comment

hebasto left a comment

Choose a reason for hiding this comment

DrahtBot commented Jun 13, 2023 •

edited

Loading