test/functional/wallet-dump.py

   1 #!/usr/bin/env python3
   2 # Copyright (c) 2016 The Bitcoin Core developers
   3 # Distributed under the MIT software license, see the accompanying
   4 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5 """Test the dumpwallet RPC."""
   6
   7 import os
   8
   9 from test_framework.test_framework import BitcoinTestFramework
  10 from test_framework.util import (assert_equal, assert_raises_rpc_error)
  11
  12
  13 def read_dump(file_name, addrs, hd_master_addr_old):
  14     """
  15     Read the given dump, count the addrs that match, count change and reserve.
  16     Also check that the old hd_master is inactive
  17     """
  18     with open(file_name, encoding='utf8') as inputfile:
  19         found_addr = 0
  20         found_addr_chg = 0
  21         found_addr_rsv = 0
  22         hd_master_addr_ret = None
  23         for line in inputfile:
  24             # only read non comment lines
  25             if line[0] != "#" and len(line) > 10:
  26                 # split out some data
  27                 key_label, comment = line.split("#")
  28                 # key = key_label.split(" ")[0]
  29                 keytype = key_label.split(" ")[2]
  30                 if len(comment) > 1:
  31                     addr_keypath = comment.split(" addr=")[1]
  32                     addr = addr_keypath.split(" ")[0]
  33                     keypath = None
  34                     if keytype == "inactivehdmaster=1":
  35                         # ensure the old master is still available
  36                         assert(hd_master_addr_old == addr)
  37                     elif keytype == "hdmaster=1":
  38                         # ensure we have generated a new hd master key
  39                         assert(hd_master_addr_old != addr)
  40                         hd_master_addr_ret = addr
  41                     else:
  42                         keypath = addr_keypath.rstrip().split("hdkeypath=")[1]
  43
  44                     # count key types
  45                     for addrObj in addrs:
  46                         if addrObj['address'] == addr and addrObj['hdkeypath'] == keypath and keytype == "label=":
  47                             found_addr += 1
  48                             break
  49                         elif keytype == "change=1":
  50                             found_addr_chg += 1
  51                             break
  52                         elif keytype == "reserve=1":
  53                             found_addr_rsv += 1
  54                             break
  55         return found_addr, found_addr_chg, found_addr_rsv, hd_master_addr_ret
  56
  57
  58 class WalletDumpTest(BitcoinTestFramework):
  59     def set_test_params(self):
  60         self.num_nodes = 1
  61         self.extra_args = [["-keypool=90"]]
  62
  63     def setup_network(self, split=False):
  64         # Use 1 minute timeout because the initial getnewaddress RPC can take
  65         # longer than the default 30 seconds due to an expensive
  66         # CWallet::TopUpKeyPool call, and the encryptwallet RPC made later in
  67         # the test often takes even longer.
  68         self.add_nodes(self.num_nodes, self.extra_args, timewait=60)
  69         self.start_nodes()
  70
  71     def run_test (self):
  72         tmpdir = self.options.tmpdir
  73
  74         # generate 20 addresses to compare against the dump
  75         test_addr_count = 20
  76         addrs = []
  77         for i in range(0,test_addr_count):
  78             addr = self.nodes[0].getnewaddress()
  79             vaddr= self.nodes[0].validateaddress(addr) #required to get hd keypath
  80             addrs.append(vaddr)
  81         # Should be a no-op:
  82         self.nodes[0].keypoolrefill()
  83
  84         # dump unencrypted wallet
  85         result = self.nodes[0].dumpwallet(tmpdir + "/node0/wallet.unencrypted.dump")
  86         assert_equal(result['filename'], os.path.abspath(tmpdir + "/node0/wallet.unencrypted.dump"))
  87
  88         found_addr, found_addr_chg, found_addr_rsv, hd_master_addr_unenc = \
  89             read_dump(tmpdir + "/node0/wallet.unencrypted.dump", addrs, None)
  90         assert_equal(found_addr, test_addr_count)  # all keys must be in the dump
  91         assert_equal(found_addr_chg, 50)  # 50 blocks where mined
  92         assert_equal(found_addr_rsv, 90*2) # 90 keys plus 100% internal keys
  93
  94         #encrypt wallet, restart, unlock and dump
  95         self.nodes[0].node_encrypt_wallet('test')
  96         self.start_node(0)
  97         self.nodes[0].walletpassphrase('test', 10)
  98         # Should be a no-op:
  99         self.nodes[0].keypoolrefill()
 100         self.nodes[0].dumpwallet(tmpdir + "/node0/wallet.encrypted.dump")
 101
 102         found_addr, found_addr_chg, found_addr_rsv, _ = \
 103             read_dump(tmpdir + "/node0/wallet.encrypted.dump", addrs, hd_master_addr_unenc)
 104         assert_equal(found_addr, test_addr_count)
 105         assert_equal(found_addr_chg, 90*2 + 50)  # old reserve keys are marked as change now
 106         assert_equal(found_addr_rsv, 90*2)
 107
 108         # Overwriting should fail
 109         assert_raises_rpc_error(-8, "already exists", self.nodes[0].dumpwallet, tmpdir + "/node0/wallet.unencrypted.dump")
 110
 111 if __name__ == '__main__':
 112     WalletDumpTest().main ()