Add a new RPC command: restorewallet by lsilva01 · Pull Request #22541 · bitcoin/bitcoin

lsilva01 · 2021-07-24T23:21:36Z

As far as I know, there is no command to restore the wallet from a backup file.
The only way to do this is to replace the wallet.dat of a newly created wallet with the backup file, which is hardly an intuitive way.

This PR implements the restorewallet RPC command which restores the wallet from the backup file.

To test:
First create a backup file:
$ bitcoin-cli -rpcwallet="wallet-01" backupwallet /home/Backups/wallet-01.bak

Then restore it in another wallet:
$ bitcoin-cli restorewallet "restored-wallet-01" /home/Backups/wallet-01.bak

ghost

CI is failing because of whitespace at few places https://cirrus-ci.com/task/6700329929539584

You can automatically remove this pre commit by using "files.trimTrailingWhitespace": true in VS Code

src/wallet/rpcwallet.cpp

Rspigler · 2021-07-27T19:57:52Z

Concept ACK!

laanwj · 2021-07-28T14:45:07Z

Concept ACK. I think this is more of an importwallet than restorewallet in the sense that an external wallet file is being imported into the data directory, which is slightly more general. But no strong opinion on RPC naming (ofc, importwallet already exists and does something else,).

The only way to do this is to replace the wallet.dat of a newly created wallet with the backup file, which is hardly an intuitive way.

I don't think the replacement part is necessary (or desirable). As I understand, you can place it in the wallets directory then do loadwallet.

Needs a RPC test.

src/wallet/rpcwallet.cpp

ghost · 2021-07-29T01:24:33Z

As I understand, you can place it in the wallets directory then do loadwallet

This gives error:

$ bitcoin-cli loadwallet "B1.dat"

error code: -4
error message:
BerkeleyDatabase: Can't open database B1.dat (duplicates fileid b6050000000024007aceafe40000000000000000 from wallet.dat)

S3RK · 2021-07-29T06:56:47Z

@prayank23 the error says that you are trying to load a copy of already existing wallet. Try the same with the wallet created on another node

ghost · 2021-07-29T12:14:02Z

the error says that you are trying to load a copy of already existing wallet. Try the same with the wallet created on another node

Right. Wallet will be different when users restore from backup. Because if there is already a wallet, there is no need to restore.

Or it can be same in few cases?

achow101

Concept ACK

src/wallet/rpcwallet.cpp

lsilva01 · 2021-07-30T19:32:43Z

test/functional/wallet_backup.py has been changed to use the restorewallet command instead of manually inserting the files.
The original test stopped nodes before inserting them. As this is no longer necessary, the backup files are used to restore the wallets on the fourth node without restarting it.

src/wallet/rpcwallet.cpp

lsilva01 · 2021-08-10T02:37:12Z

5b0a506: Adds a helper function to load the wallet which is used by restorewallet and loadwallet.

8f87ef4: Increases coverage ofrestorewallet test. Adds restore_nonexistent_wallet and restore_wallet_existent_name functions.

achow101 · 2021-08-10T20:20:46Z

ACK 8f87ef44013caf78e1405ca89f8097cbde1a11b0

src/wallet/rpcwallet.cpp

… instead of restoring wallets manually.

achow101 · 2021-08-13T20:38:44Z

re-ACK 5fe8100

DrahtBot · 2021-08-14T01:36:24Z

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

Conflicts

Reviewers, this pull request conflicts with the following ones:

#19101 (refactor: remove ::vpwallets and related global variables by ryanofsky)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

meshcollider

utACK 5fe8100

ghost · 2021-08-15T10:09:16Z

tACK 5fe8100

Tested on windows with below commands:

Create wallet W1:
```
bitcoin-cli createwallet W1
```

Backup wallet:

bitcoin-cli -rpcwallet="w1" backupwallet "D:\Backups\backup_W1.dat"

Delete wallet directory regtest\wallets\W1

Restore wallet from backup:

bitcoin-cli restorewallet "W1" "D:\Backups\backup_W1.dat"

{
 "name": "W1",
 "warning": ""
}

Check wallet info: bitcoin-cli -rpcwallet="W1" getwalletinfo

meshcollider · 2021-08-15T13:53:49Z

Great first contribution, thank you! 🎉

5fe8100 Change the wallet_backup.py test to use the restorewallet RPC command instead of restoring wallets manually. (lsilva01) ae23fab Add a new RPC command: restorewallet (lsilva01) Pull request description: As far as I know, there is no command to restore the wallet from a backup file. The only way to do this is to replace the `wallet.dat` of a newly created wallet with the backup file, which is hardly an intuitive way. This PR implements the `restorewallet` RPC command which restores the wallet from the backup file. To test: First create a backup file: `$ bitcoin-cli -rpcwallet="wallet-01" backupwallet /home/Backups/wallet-01.bak` Then restore it in another wallet: `$ bitcoin-cli restorewallet "restored-wallet-01" /home/Backups/wallet-01.bak` ACKs for top commit: achow101: re-ACK 5fe8100 prayank23: tACK bitcoin@5fe8100 meshcollider: utACK 5fe8100 Tree-SHA512: 9639df4d8ad32f255f5b868320dc69878bd9aceb3b471b49dfad500b67681e2d354292b5410982fbf18e25a44ed0c06fd4a0dd010e82807c2e00ff32e84047a1

DrahtBot added RPC/REST/ZMQ Wallet labels Jul 24, 2021

Imanuelc112 approved these changes Jul 25, 2021

View reviewed changes

lsilva01 mentioned this pull request Jul 25, 2021

Document about wallet backup and restoration #22523

Merged

lsilva01 force-pushed the restore_wallet_command branch 3 times, most recently from 587d0d3 to b1b6a4f Compare July 26, 2021 21:06

ghost suggested changes Jul 27, 2021

View reviewed changes

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

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

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

lsilva01 force-pushed the restore_wallet_command branch from b1b6a4f to 7b1b40a Compare July 27, 2021 17:52

Rspigler mentioned this pull request Jul 27, 2021

Restore wallet via the GUI bitcoin-core/gui#383

Closed

laanwj reviewed Jul 28, 2021

View reviewed changes

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

achow101 reviewed Jul 29, 2021

View reviewed changes

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

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

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

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

lsilva01 force-pushed the restore_wallet_command branch 2 times, most recently from 22f6d7b to 2f70a30 Compare July 29, 2021 20:47

lsilva01 changed the title ~~Add a new RPC command: restorewalletfrombackup~~ Add a new RPC command: restorewallet Jul 29, 2021

lsilva01 mentioned this pull request Jul 30, 2021

Cirrus CI showed error in netaddress.cpp file when checking PR #22588

Closed

achow101 reviewed Jul 30, 2021

View reviewed changes

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

lsilva01 force-pushed the restore_wallet_command branch 2 times, most recently from 98c291c to bc241c7 Compare July 30, 2021 19:23

achow101 reviewed Aug 9, 2021

View reviewed changes

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

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

lsilva01 force-pushed the restore_wallet_command branch from bc241c7 to 8f87ef4 Compare August 10, 2021 02:06

achow101 reviewed Aug 10, 2021

View reviewed changes

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

lsilva01 added 2 commits August 10, 2021 22:44

Add a new RPC command: restorewallet

ae23fab

Change the wallet_backup.py test to use the restorewallet RPC command…

5fe8100

… instead of restoring wallets manually.

lsilva01 force-pushed the restore_wallet_command branch from 8f87ef4 to 5fe8100 Compare August 11, 2021 02:28

DrahtBot mentioned this pull request Aug 14, 2021

refactor: remove ::vpwallets and related global variables #19101

Merged

meshcollider reviewed Aug 15, 2021

View reviewed changes

meshcollider merged commit 502d22c into bitcoin:master Aug 15, 2021

lsilva01 deleted the restore_wallet_command branch August 23, 2021 13:11

luke-jr mentioned this pull request Sep 12, 2021

Restrict RPCs that make server-side files #20866

Open

achow101 mentioned this pull request Sep 19, 2021

Built in restore wallet #20148

Closed

achow101 mentioned this pull request Oct 20, 2021

About restore the wallet #23313

Closed

bitcoin locked as resolved and limited conversation to collaborators Aug 23, 2022

Conversation

lsilva01 commented Jul 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rspigler commented Jul 27, 2021

Uh oh!

laanwj commented Jul 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

ghost commented Jul 29, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

S3RK commented Jul 29, 2021

Uh oh!

ghost commented Jul 29, 2021

Uh oh!

achow101 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lsilva01 commented Jul 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lsilva01 commented Aug 10, 2021

Uh oh!

achow101 commented Aug 10, 2021

Uh oh!

Uh oh!

achow101 commented Aug 13, 2021

Uh oh!

DrahtBot commented Aug 14, 2021

Conflicts

Uh oh!

meshcollider left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Aug 15, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

meshcollider commented Aug 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

lsilva01 commented Jul 24, 2021 •

edited

Loading

laanwj commented Jul 28, 2021 •

edited

Loading

ghost commented Jul 29, 2021 •

edited by ghost

Loading

lsilva01 commented Jul 30, 2021 •

edited

Loading

ghost commented Aug 15, 2021 •

edited by ghost

Loading