mirror of
https://github.com/dashpay/dash.git
synced 2024-12-26 04:22:55 +01:00
19b2b27785
3eb6f8b2e61c24a22ea9396d86672307845f35eb wallet (not for backport): improve upgradewallet error messages (Jon Atack) ca8cd893bb56bf5d455154b0498b1f58f77d20ed wallet: fix and improve upgradewallet error responses (Jon Atack) 99d56e357159c7154f69f28cb5587c5ca20d6594 wallet: fix and improve upgradewallet result responses (Jon Atack) 2498b04ce88696a3216fc38b7d393906b733e8b1 Don't upgrade to HD split if it is already supported (Andrew Chow) c46c18b788cb0862aafbb116fd37936cbed6a431 wallet: refactor GetClosestWalletFeature() (Jon Atack) Pull request description: This follows up on #18836 and #20282 to fix and improve the as-yet unreleased `upgradewallet` feature and also implement review follow-up in https://github.com/bitcoin/bitcoin/pull/18836#discussion_r519328607. This PR fixes 4 upgradewallet issues: - this bug: https://github.com/bitcoin/bitcoin/pull/20403#discussion_r526063920 - it returns nothing in the absence of an RPC error, which isn't reassuring for users - it returns the same thing both in the case of a successful upgrade and when no upgrade took place - the error message object is currently dead code This PR fixes the above and provides: ...user feedback to not silently return without upgrading ``` { "wallet_name": "disable private keys", "previous_version": 169900, "current_version": 169900, "result": "Already at latest version. Wallet version unchanged." } ``` ...better feedback after successfully upgrading ``` { "wallet_name": "watch-only", "previous_version": 159900, "current_version": 169900, "result": "Wallet upgraded successfully from version 159900 to version 169900." } ``` ...helpful error responses ``` { "wallet_name": "blank", "previous_version": 169900, "current_version": 169900, "error": "Cannot downgrade wallet from version 169900 to version 159900. Wallet version unchanged." } { "wallet_name": "blank", "previous_version": 130000, "current_version": 130000, "error": "Cannot upgrade a non HD split wallet from version 130000 to version 169899 without upgrading to support pre-split keypool. Please use version 169900 or no version specified." } ``` updated help: ``` upgradewallet ( version ) Upgrade the wallet. Upgrades to the latest version if no version number is specified. New keys may be generated and a new wallet backup will need to be made. Arguments: 1. version (numeric, optional, default=169900) The version number to upgrade to. Default is the latest wallet version. Result: { (json object) "wallet_name" : "str", (string) Name of wallet this operation was performed on "previous_version" : n, (numeric) Version of wallet before this operation "current_version" : n, (numeric) Version of wallet after this operation "result" : "str", (string, optional) Description of result, if no error "error" : "str" (string, optional) Error message (if there is one) } ``` ACKs for top commit: achow101: ACK 3eb6f8b MarcoFalke: review ACK 3eb6f8b2e61c24a22ea9396d86672307845f35eb 🛡 Tree-SHA512: b767314069e26b5933b123acfea6aa40708507f504bdb22884da020a4ca1332af38a7072b061e36281533af9f4e236d94d3c129daf6fe5b55241127537038eed
240 lines
10 KiB
Python
Executable File
240 lines
10 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# Copyright (c) 2018-2020 The Bitcoin Core developers
|
|
# Distributed under the MIT software license, see the accompanying
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
"""upgradewallet RPC functional test
|
|
|
|
Requires previous releases binaries, see test/README.md.
|
|
Only v0.15.2 and v0.16.3 are required by this test. The others are used in feature_backwards_compatibility.py
|
|
"""
|
|
|
|
import os
|
|
import shutil
|
|
import struct
|
|
|
|
from test_framework.bdb import dump_bdb_kv
|
|
from test_framework.blocktools import COINBASE_MATURITY
|
|
from test_framework.test_framework import BitcoinTestFramework
|
|
from test_framework.util import (
|
|
assert_equal,
|
|
assert_greater_than,
|
|
assert_is_hex_string,
|
|
sha256sum_file,
|
|
)
|
|
|
|
|
|
UPGRADED_KEYMETA_VERSION = 12
|
|
|
|
class UpgradeWalletTest(BitcoinTestFramework):
|
|
def set_test_params(self):
|
|
self.setup_clean_chain = True
|
|
self.num_nodes = 3
|
|
self.extra_args = [
|
|
["-keypool=2"], # current wallet version
|
|
["-usehd=1", "-keypool=2"], # v18.2.2 wallet
|
|
["-usehd=0", "-keypool=2"], # v0.16.1.1 wallet
|
|
]
|
|
self.wallet_names = [self.default_wallet_name, None, None]
|
|
|
|
def skip_test_if_missing_module(self):
|
|
self.skip_if_no_wallet()
|
|
self.skip_if_no_bdb()
|
|
self.skip_if_no_previous_releases()
|
|
|
|
def setup_nodes(self):
|
|
self.add_nodes(self.num_nodes, extra_args=self.extra_args, versions=[
|
|
None,
|
|
18020200, # that's last version before `default wallets` are created
|
|
160101, # that's oldest version that support `import_deterministic_coinbase_privkeys`
|
|
])
|
|
self.start_nodes()
|
|
self.import_deterministic_coinbase_privkeys()
|
|
|
|
def dumb_sync_blocks(self):
|
|
"""
|
|
Little helper to sync older wallets.
|
|
Notice that v0.15.2's regtest is hardforked, so there is
|
|
no sync for it.
|
|
v0.15.2 is only being used to test for version upgrade
|
|
and master hash key presence.
|
|
v0.16.3 is being used to test for version upgrade and balances.
|
|
Further info: https://github.com/bitcoin/bitcoin/pull/18774#discussion_r416967844
|
|
"""
|
|
node_from = self.nodes[0]
|
|
v18_2_node = self.nodes[1]
|
|
to_height = node_from.getblockcount()
|
|
height = self.nodes[1].getblockcount()
|
|
for i in range(height, to_height+1):
|
|
b = node_from.getblock(blockhash=node_from.getblockhash(i), verbose=0)
|
|
v18_2_node.submitblock(b)
|
|
assert_equal(v18_2_node.getblockcount(), to_height)
|
|
|
|
def test_upgradewallet(self, wallet, previous_version, requested_version=None, expected_version=None):
|
|
unchanged = expected_version == previous_version
|
|
new_version = previous_version if unchanged else expected_version if expected_version else requested_version
|
|
assert_equal(wallet.getwalletinfo()["walletversion"], previous_version)
|
|
assert_equal(wallet.upgradewallet(requested_version),
|
|
{
|
|
"wallet_name": "",
|
|
"previous_version": previous_version,
|
|
"current_version": new_version,
|
|
"result": "Already at latest version. Wallet version unchanged." if unchanged else "Wallet upgraded successfully from version {} to version {}.".format(previous_version, new_version),
|
|
}
|
|
)
|
|
assert_equal(wallet.getwalletinfo()["walletversion"], new_version)
|
|
|
|
def test_upgradewallet_error(self, wallet, previous_version, requested_version, msg):
|
|
assert_equal(wallet.getwalletinfo()["walletversion"], previous_version)
|
|
assert_equal(wallet.upgradewallet(requested_version),
|
|
{
|
|
"wallet_name": "",
|
|
"previous_version": previous_version,
|
|
"current_version": previous_version,
|
|
"error": msg,
|
|
}
|
|
)
|
|
assert_equal(wallet.getwalletinfo()["walletversion"], previous_version)
|
|
|
|
def run_test(self):
|
|
self.nodes[0].generatetoaddress(COINBASE_MATURITY + 1, self.nodes[0].getnewaddress())
|
|
self.dumb_sync_blocks()
|
|
# # Sanity check the test framework:
|
|
res = self.nodes[0].getblockchaininfo()
|
|
assert_equal(res['blocks'], COINBASE_MATURITY + 1)
|
|
node_master = self.nodes[0]
|
|
v18_2_node = self.nodes[1]
|
|
v16_1_node = self.nodes[2]
|
|
|
|
# Send coins to old wallets for later conversion checks.
|
|
v18_2_wallet = v18_2_node.get_wallet_rpc(self.default_wallet_name)
|
|
v18_2_address = v18_2_wallet.getnewaddress()
|
|
node_master.generatetoaddress(COINBASE_MATURITY + 1, v18_2_address)
|
|
self.dumb_sync_blocks()
|
|
v18_2_balance = v18_2_wallet.getbalance()
|
|
|
|
self.log.info("Test upgradewallet RPC...")
|
|
# Prepare for copying of the older wallet
|
|
node_master_wallet_dir = os.path.join(node_master.datadir, "regtest/wallets", self.default_wallet_name)
|
|
node_master_wallet = os.path.join(node_master_wallet_dir, self.default_wallet_name, self.wallet_data_filename)
|
|
v18_2_wallet = os.path.join(v18_2_node.datadir, "regtest/wallets/wallet.dat")
|
|
v16_1_wallet = os.path.join(v16_1_node.datadir, "regtest/wallets/wallet.dat")
|
|
self.stop_nodes()
|
|
|
|
shutil.rmtree(node_master_wallet_dir)
|
|
os.mkdir(node_master_wallet_dir)
|
|
shutil.copy(
|
|
v18_2_wallet,
|
|
node_master_wallet_dir
|
|
)
|
|
self.restart_node(0, ['-nowallet'])
|
|
node_master.loadwallet('')
|
|
|
|
def copy_v16():
|
|
node_master.get_wallet_rpc(self.default_wallet_name).unloadwallet()
|
|
# Copy the 0.16.3 wallet to the last Dash Core version and open it:
|
|
shutil.rmtree(node_master_wallet_dir)
|
|
os.mkdir(node_master_wallet_dir)
|
|
shutil.copy(
|
|
v18_2_wallet,
|
|
node_master_wallet_dir
|
|
)
|
|
node_master.loadwallet(self.default_wallet_name)
|
|
|
|
def copy_non_hd():
|
|
node_master.get_wallet_rpc(self.default_wallet_name).unloadwallet()
|
|
# Copy the 19.3.0 wallet to the last Dash Core version and open it:
|
|
shutil.rmtree(node_master_wallet_dir)
|
|
os.mkdir(node_master_wallet_dir)
|
|
shutil.copy(
|
|
v16_1_wallet,
|
|
node_master_wallet_dir
|
|
)
|
|
node_master.loadwallet(self.default_wallet_name)
|
|
|
|
|
|
self.restart_node(0)
|
|
copy_v16()
|
|
wallet = node_master.get_wallet_rpc(self.default_wallet_name)
|
|
self.test_upgradewallet(wallet, previous_version=120200, expected_version=120200)
|
|
# wallet should still contain the same balance
|
|
assert_equal(wallet.getbalance(), v18_2_balance)
|
|
|
|
copy_non_hd()
|
|
wallet = node_master.get_wallet_rpc(self.default_wallet_name)
|
|
# should have no master key hash before conversion
|
|
assert_equal('hdchainid' in wallet.getwalletinfo(), False)
|
|
# calling upgradewallet with explicit version number
|
|
# should return nothing if successful
|
|
|
|
self.log.info("Test upgradewallet to HD will have version 120200 but no HD seed actually appeared")
|
|
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)
|
|
new_version = wallet.getwalletinfo()["walletversion"]
|
|
assert_equal(new_version, 120200)
|
|
assert_is_hex_string(wallet.getwalletinfo()['hdchainid'])
|
|
|
|
self.log.info("Intermediary versions don't effect anything")
|
|
copy_non_hd()
|
|
# Wallet starts with 61000 (legacy "latest")
|
|
assert_equal(61000, wallet.getwalletinfo()['walletversion'])
|
|
wallet.unloadwallet()
|
|
before_checksum = sha256sum_file(node_master_wallet)
|
|
node_master.loadwallet('')
|
|
# Test an "upgrade" from 61000 to 120199 has no effect, as the next version is 120200
|
|
self.test_upgradewallet(wallet, previous_version=61000, requested_version=120199, expected_version=61000)
|
|
wallet.unloadwallet()
|
|
assert_equal(before_checksum, sha256sum_file(node_master_wallet))
|
|
node_master.loadwallet('')
|
|
|
|
self.log.info('Wallets cannot be downgraded')
|
|
copy_non_hd()
|
|
self.test_upgradewallet_error(wallet, previous_version=61000, requested_version=40000,
|
|
msg="Cannot downgrade wallet from version 61000 to version 40000. Wallet version unchanged.")
|
|
wallet.unloadwallet()
|
|
assert_equal(before_checksum, sha256sum_file(node_master_wallet))
|
|
node_master.loadwallet('')
|
|
|
|
self.log.info('Can upgrade to HD')
|
|
# Inspect the old wallet and make sure there is no hdchain
|
|
orig_kvs = dump_bdb_kv(node_master_wallet)
|
|
assert b'\x07hdchain' not in orig_kvs
|
|
# Upgrade to HD
|
|
self.test_upgradewallet(wallet, previous_version=61000, requested_version=120200)
|
|
# Check that there is now a hd chain and it is version 1, no internal chain counter
|
|
new_kvs = dump_bdb_kv(node_master_wallet)
|
|
wallet.upgradetohd()
|
|
new_kvs = dump_bdb_kv(node_master_wallet)
|
|
assert b'\x07hdchain' in new_kvs
|
|
hd_chain = new_kvs[b'\x07hdchain']
|
|
# hd_chain:
|
|
# obj.nVersion int
|
|
# obj.id uint256
|
|
# obj.fCrypted bool
|
|
# obj.vchSeed SecureVector
|
|
# obj.vchMnemonic SecureVector
|
|
# obj.vchMnemonicPassphrase SecureVector
|
|
# obj.mapAccounts map<> accounts
|
|
assert_greater_than(220, len(hd_chain))
|
|
assert_greater_than(len(hd_chain), 180)
|
|
hd_chain_version, seed_id, is_crypted = struct.unpack('<i32s?', hd_chain[:37])
|
|
assert_equal(1, hd_chain_version)
|
|
seed_id = bytearray(seed_id)
|
|
seed_id.reverse()
|
|
# Next key should be HD
|
|
info = wallet.getaddressinfo(wallet.getnewaddress())
|
|
assert_equal(seed_id.hex(), info['hdchainid'])
|
|
assert_equal("m/44'/1'/0'/0/0", info['hdkeypath'])
|
|
prev_seed_id = info['hdchainid']
|
|
# Change key should be the same keypool
|
|
info = wallet.getaddressinfo(wallet.getrawchangeaddress())
|
|
assert_equal(prev_seed_id, info['hdchainid'])
|
|
assert_equal("m/44'/1'/0'/1/0", info['hdkeypath'])
|
|
|
|
assert_equal(120200, wallet.getwalletinfo()['walletversion'])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
UpgradeWalletTest().main()
|