[BUG][Wallet] Restore AddressBook when marking used keys in the keypool #2117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
furszy
previously approved these changes
Jan 21, 2021
random-zebra
force-pushed
the
202012_wallet_restore-addressbook
branch
from
67cc427
to
a36a618
Compare
|
👍 done. |
**Problem:** If a HD wallet uses some keys, and is later restored to a previous state (initial backup), it correctly recognizes the used keys and relative transactions, and spending from the relative addresses works fine. Although, these addresses are not shown in the receive widget of the GUI, so their label cannot be edited, and they cannot be easily selected/copied. **Cause** When adding a transaction in `AddToWalletIfInvolvingMe`, the wallet loops over the outputs and checks if it affects any key from the keypool (supposed to be "unused"), in which case, it removes the key from the pool (`ScriptPubKeyMan::MarkUnusedAddresses`). After restoring the old backup, when initializing the receive widget (and address table model), with `getAddressToShow`, there is no unused address in the AddressBook, and a new one is created. `getNewAddress` accesses the key pool and returns the first unused key. Since the used keys have been removed, this is a brand new address. All addresses relative to the keys removed from the pool in `MarkUnusedAddresses`, therefore, never enter the AddressBook, and thus are never shown in the receive widget. **Solution** When removing the key from the pool (in `MarkReserveKeysAsUsed`), also add the missing address to the AddressBook, with receive/coldstaking purpose. This way, when restoring an old backup, the user loses only the labels (that were added after the wallet.dat backup) but can still repopulate his AddressBook with all the previously used addresses.
random-zebra
force-pushed
the
202012_wallet_restore-addressbook
branch
from
a36a618
to
390adc1
Compare
furszy
reviewed
Jan 23, 2021
furszy
approved these changes
Jan 23, 2021
Fuzzbawls
approved these changes
Jan 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
If a HD wallet uses some keys, and is later restored to a previous state (initial backup), it correctly recognizes the used keys and relative transactions, and spending from the relative addresses works fine.
Although, these addresses are not shown in the receive widget of the GUI, so their label cannot be edited, and they cannot be easily selected/copied.
Cause
When adding a transaction in
AddToWalletIfInvolvingMe, the wallet loops over the outputs and checks if it affects any key from the keypool (supposed to be "unused"), in which case, it removes the key from the pool (ScriptPubKeyMan::MarkUnusedAddresses).After restoring the old backup, when initializing the receive widget (and address table model), with
getAddressToShow, there is no unused address in the AddressBook, and a new one is created.getNewAddressaccesses the key pool and returns the first unused key.Since the used keys have been removed, this is a brand new address.
All addresses relative to the keys removed from the pool in
MarkUnusedAddresses, therefore, never enter the AddressBook, and thus are never shown in the receive widget.Solution
When removing the key from the pool (in
MarkReserveKeysAsUsed), also add the missing address to the AddressBook, with receive/coldstaking purpose.This way, when restoring an old backup, the user loses only the labels (that were added after the wallet.dat backup) but can still repopulate his AddressBook with all the previously used addresses.