2016-07-29 17:37:57 +02:00
|
|
|
#!/usr/bin/env python3
|
|
|
|
# Copyright (c) 2016 The Bitcoin Core developers
|
|
|
|
# Distributed under the MIT software license, see the accompanying
|
|
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
2019-01-07 10:55:35 +01:00
|
|
|
"""Test the dumpwallet RPC."""
|
2019-09-25 10:45:53 +02:00
|
|
|
import os
|
2016-07-29 17:37:57 +02:00
|
|
|
|
|
|
|
from test_framework.test_framework import BitcoinTestFramework
|
2018-03-07 16:29:57 +01:00
|
|
|
from test_framework.util import (
|
|
|
|
assert_equal,
|
|
|
|
assert_raises_rpc_error,
|
|
|
|
)
|
2016-08-03 10:58:25 +02:00
|
|
|
|
|
|
|
|
2017-12-21 11:29:51 +01:00
|
|
|
def read_dump(file_name, addrs, script_addrs, hd_master_addr_old):
|
2016-08-03 10:58:25 +02:00
|
|
|
"""
|
|
|
|
Read the given dump, count the addrs that match, count change and reserve.
|
|
|
|
Also check that the old hd_master is inactive
|
|
|
|
"""
|
2018-01-31 10:37:15 +01:00
|
|
|
with open(file_name, encoding='utf8') as inputfile:
|
2016-08-03 10:58:25 +02:00
|
|
|
found_addr = 0
|
2017-12-21 11:29:51 +01:00
|
|
|
found_script_addr = 0
|
2016-08-03 10:58:25 +02:00
|
|
|
found_addr_chg = 0
|
|
|
|
found_addr_rsv = 0
|
|
|
|
hd_master_addr_ret = None
|
|
|
|
for line in inputfile:
|
|
|
|
# only read non comment lines
|
|
|
|
if line[0] != "#" and len(line) > 10:
|
|
|
|
# split out some data
|
2018-09-10 22:58:15 +02:00
|
|
|
key_date_label, comment = line.split("#")
|
|
|
|
key_date_label = key_date_label.split(" ")
|
|
|
|
# key = key_date_label[0]
|
|
|
|
date = key_date_label[1]
|
|
|
|
keytype = key_date_label[2]
|
2018-09-13 23:45:32 +02:00
|
|
|
|
|
|
|
imported_key = date == '1970-01-01T00:00:01Z'
|
|
|
|
if imported_key:
|
|
|
|
# Imported keys have multiple addresses, no label (keypath) and timestamp
|
|
|
|
# Skip them
|
2018-09-10 22:58:15 +02:00
|
|
|
continue
|
|
|
|
|
|
|
|
addr_keypath = comment.split(" addr=")[1]
|
|
|
|
addr = addr_keypath.split(" ")[0]
|
|
|
|
keypath = None
|
|
|
|
if keytype == "inactivehdseed=1":
|
|
|
|
# ensure the old master is still available
|
2021-08-27 21:03:02 +02:00
|
|
|
assert hd_master_addr_old == addr
|
2018-09-10 22:58:15 +02:00
|
|
|
elif keytype == "hdseed=1":
|
|
|
|
# ensure we have generated a new hd master key
|
2021-08-27 21:03:02 +02:00
|
|
|
assert hd_master_addr_old != addr
|
2018-09-10 22:58:15 +02:00
|
|
|
hd_master_addr_ret = addr
|
|
|
|
elif keytype == "script=1":
|
|
|
|
# scripts don't have keypaths
|
2016-08-03 10:58:25 +02:00
|
|
|
keypath = None
|
2018-09-10 22:58:15 +02:00
|
|
|
else:
|
|
|
|
keypath = addr_keypath.rstrip().split("hdkeypath=")[1]
|
|
|
|
|
|
|
|
# count key types
|
|
|
|
for addrObj in addrs:
|
|
|
|
if addrObj['address'] == addr and addrObj['hdkeypath'] == keypath and keytype == "label=":
|
|
|
|
found_addr += 1
|
|
|
|
break
|
|
|
|
elif keytype == "change=1":
|
|
|
|
found_addr_chg += 1
|
|
|
|
break
|
|
|
|
elif keytype == "reserve=1":
|
|
|
|
found_addr_rsv += 1
|
|
|
|
break
|
|
|
|
|
|
|
|
# count scripts
|
|
|
|
for script_addr in script_addrs:
|
|
|
|
if script_addr == addr.rstrip() and keytype == "script=1":
|
|
|
|
found_script_addr += 1
|
|
|
|
break
|
2017-12-21 11:29:51 +01:00
|
|
|
|
|
|
|
return found_addr, found_script_addr, found_addr_chg, found_addr_rsv, hd_master_addr_ret
|
2016-07-29 17:37:57 +02:00
|
|
|
|
|
|
|
|
|
|
|
class WalletDumpTest(BitcoinTestFramework):
|
2017-09-01 18:47:13 +02:00
|
|
|
def set_test_params(self):
|
2016-07-29 17:37:57 +02:00
|
|
|
self.num_nodes = 1
|
2022-11-30 20:23:31 +01:00
|
|
|
self.extra_args = [["-keypool=90", "-usehd=1", "-wallet=dump"]]
|
2018-08-02 14:31:47 +02:00
|
|
|
self.rpc_timeout = 120
|
2018-01-31 10:40:27 +01:00
|
|
|
|
2018-09-13 12:33:15 +02:00
|
|
|
def skip_test_if_missing_module(self):
|
|
|
|
self.skip_if_no_wallet()
|
|
|
|
|
2019-06-20 18:37:09 +02:00
|
|
|
def setup_network(self):
|
2022-06-12 16:11:56 +02:00
|
|
|
self.disable_mocktime()
|
2018-08-02 14:31:47 +02:00
|
|
|
self.add_nodes(self.num_nodes, extra_args=self.extra_args)
|
2017-09-01 18:47:13 +02:00
|
|
|
self.start_nodes()
|
2016-07-29 17:37:57 +02:00
|
|
|
|
2018-08-02 14:31:47 +02:00
|
|
|
def run_test(self):
|
2018-03-07 16:29:57 +01:00
|
|
|
wallet_unenc_dump = os.path.join(self.nodes[0].datadir, "wallet.unencrypted.dump")
|
|
|
|
wallet_enc_dump = os.path.join(self.nodes[0].datadir, "wallet.encrypted.dump")
|
2016-07-29 17:37:57 +02:00
|
|
|
|
2016-08-03 10:58:25 +02:00
|
|
|
# generate 20 addresses to compare against the dump
|
2016-07-29 17:37:57 +02:00
|
|
|
test_addr_count = 20
|
|
|
|
addrs = []
|
|
|
|
for i in range(0,test_addr_count):
|
|
|
|
addr = self.nodes[0].getnewaddress()
|
2020-12-17 13:46:20 +01:00
|
|
|
vaddr= self.nodes[0].getaddressinfo(addr) #required to get hd keypath
|
2016-07-29 17:37:57 +02:00
|
|
|
addrs.append(vaddr)
|
2016-08-03 10:58:25 +02:00
|
|
|
# Should be a no-op:
|
|
|
|
self.nodes[0].keypoolrefill()
|
2016-07-29 17:37:57 +02:00
|
|
|
|
2020-03-28 02:47:35 +01:00
|
|
|
# Test scripts dump by adding a 1-of-1 multisig address
|
2020-05-15 11:34:41 +02:00
|
|
|
multisig_addr = self.nodes[0].addmultisigaddress(1, [addrs[1]["address"]])["address"]
|
2020-03-28 02:47:35 +01:00
|
|
|
script_addrs = [multisig_addr]
|
2017-12-21 11:29:51 +01:00
|
|
|
|
2016-07-29 17:37:57 +02:00
|
|
|
# dump unencrypted wallet
|
2018-03-07 16:29:57 +01:00
|
|
|
result = self.nodes[0].dumpwallet(wallet_unenc_dump)
|
|
|
|
assert_equal(result['filename'], wallet_unenc_dump)
|
2016-07-29 17:37:57 +02:00
|
|
|
|
2017-12-21 11:29:51 +01:00
|
|
|
found_addr, found_script_addr, found_addr_chg, found_addr_rsv, hd_master_addr_unenc = \
|
2018-03-07 16:29:57 +01:00
|
|
|
read_dump(wallet_unenc_dump, addrs, script_addrs, None)
|
2016-08-03 10:58:25 +02:00
|
|
|
assert_equal(found_addr, test_addr_count) # all keys must be in the dump
|
2020-03-28 02:47:35 +01:00
|
|
|
# This is 1, not 2 because we aren't testing for witness scripts
|
|
|
|
assert_equal(found_script_addr, 1) # all scripts must be in the dump
|
2018-09-10 22:58:15 +02:00
|
|
|
assert_equal(found_addr_chg, 0) # 0 blocks where mined
|
2018-01-31 10:40:27 +01:00
|
|
|
assert_equal(found_addr_rsv, 180) # keypool size (external+internal)
|
2016-07-29 17:37:57 +02:00
|
|
|
|
|
|
|
#encrypt wallet, restart, unlock and dump
|
2018-09-14 10:28:27 +02:00
|
|
|
self.nodes[0].encryptwallet('test')
|
2020-01-25 17:20:14 +01:00
|
|
|
self.nodes[0].walletpassphrase('test', 300)
|
2016-08-03 10:58:25 +02:00
|
|
|
# Should be a no-op:
|
|
|
|
self.nodes[0].keypoolrefill()
|
2018-03-07 16:29:57 +01:00
|
|
|
self.nodes[0].dumpwallet(wallet_enc_dump)
|
2016-07-29 17:37:57 +02:00
|
|
|
|
2017-12-21 11:29:51 +01:00
|
|
|
found_addr, found_script_addr, found_addr_chg, found_addr_rsv, _ = \
|
2018-03-07 16:29:57 +01:00
|
|
|
read_dump(wallet_enc_dump, addrs, script_addrs, hd_master_addr_unenc)
|
2016-08-03 10:58:25 +02:00
|
|
|
assert_equal(found_addr, test_addr_count)
|
2020-03-28 02:47:35 +01:00
|
|
|
# This is 1, not 2 because we aren't testing for witness scripts
|
|
|
|
assert_equal(found_script_addr, 1)
|
|
|
|
# TODO clarify if we want the behavior that is tested below in Dash (only when HD seed was generated and not user-provided)
|
2018-01-31 10:40:27 +01:00
|
|
|
# assert_equal(found_addr_chg, 180 + 50) # old reserve keys are marked as change now
|
2018-02-01 11:10:56 +01:00
|
|
|
assert_equal(found_addr_rsv, 180) # keypool size
|
2016-07-29 17:37:57 +02:00
|
|
|
|
2017-10-04 15:00:59 +02:00
|
|
|
# Overwriting should fail
|
2018-03-07 16:29:57 +01:00
|
|
|
assert_raises_rpc_error(-8, "already exists", lambda: self.nodes[0].dumpwallet(wallet_enc_dump))
|
2017-10-04 15:00:59 +02:00
|
|
|
|
2017-12-21 11:29:51 +01:00
|
|
|
# Restart node with new wallet, and test importwallet
|
2022-11-03 02:50:40 +01:00
|
|
|
self.stop_node(0)
|
|
|
|
self.start_node(0, ['-wallet=w2'])
|
2017-12-21 11:29:51 +01:00
|
|
|
|
|
|
|
# Make sure the address is not IsMine before import
|
2020-12-17 13:46:20 +01:00
|
|
|
result = self.nodes[0].getaddressinfo(multisig_addr)
|
2021-08-27 21:03:02 +02:00
|
|
|
assert result['ismine'] == False
|
2017-12-21 11:29:51 +01:00
|
|
|
|
2018-03-07 16:29:57 +01:00
|
|
|
self.nodes[0].importwallet(wallet_unenc_dump)
|
2017-12-21 11:29:51 +01:00
|
|
|
|
|
|
|
# Now check IsMine is true
|
2020-12-17 13:46:20 +01:00
|
|
|
result = self.nodes[0].getaddressinfo(multisig_addr)
|
2021-08-27 21:03:02 +02:00
|
|
|
assert result['ismine'] == True
|
2017-12-21 11:29:51 +01:00
|
|
|
|
2022-06-12 16:11:56 +02:00
|
|
|
self.log.info('Check that wallet is flushed')
|
|
|
|
with self.nodes[0].assert_debug_log(['Flushing wallet.dat'], timeout=20):
|
|
|
|
self.nodes[0].getnewaddress()
|
|
|
|
|
|
|
|
|
2016-07-29 17:37:57 +02:00
|
|
|
if __name__ == '__main__':
|
2018-03-07 16:29:57 +01:00
|
|
|
WalletDumpTest().main()
|