READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

7,770 bytes · SHA-256 403b76a1eb6843e2… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2016-present 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 Hierarchical Deterministic wallet function."""
6
7import shutil
8
9from test_framework.blocktools import COINBASE_MATURITY
10from test_framework.descriptors import descsum_create
11from test_framework.test_framework import BitcoinTestFramework
12from test_framework.util import (
13    assert_equal,
14    wallet_importprivkey,
15    assert_raises_rpc_error,
16)
17
18
19class WalletHDTest(BitcoinTestFramework):
20    def set_test_params(self):
21        self.setup_clean_chain = True
22        self.num_nodes = 2
23        self.extra_args = [[], ['-keypool=0']]
24        # whitelist peers to speed up tx relay / mempool sync
25        self.noban_tx_relay = True
26
27    def skip_test_if_missing_module(self):
28        self.skip_if_no_wallet()
29
30    def test_addhdkey(self):
31        self.log.info("Test addhdkey")
32        def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
33        self.nodes[0].createwallet("hdkey")
34        wallet = self.nodes[0].get_wallet_rpc("hdkey")
35
36        assert_equal(len(wallet.gethdkeys()), 1)
37
38        wallet.addhdkey()
39        xpub_info = wallet.gethdkeys()
40        assert_equal(len(xpub_info), 2)
41        for x in xpub_info:
42            if len(x["descriptors"]) == 1 and x["descriptors"][0]["desc"].startswith("unused("):
43                break
44        else:
45            assert False, "Did not find HD key with no descriptors"
46
47        imp_xpub_info = def_wallet.gethdkeys(private=True)[0]
48        imp_xpub = imp_xpub_info["xpub"]
49        imp_xprv = imp_xpub_info["xprv"]
50
51        assert_raises_rpc_error(-5, "Extended public key (xpub) provided, but extended private key (xprv) is required", wallet.addhdkey, imp_xpub)
52        add_res = wallet.addhdkey(imp_xprv)
53        expected_unused_desc = descsum_create(f"unused({imp_xpub})")
54        assert_equal(add_res["xpub"], imp_xpub)
55        xpub_info = wallet.gethdkeys()
56        assert_equal(len(xpub_info), 3)
57        for x in xpub_info:
58            if x["xpub"] == imp_xpub:
59                assert_equal(len(x["descriptors"]), 1)
60                assert_equal(x["descriptors"][0]["desc"], expected_unused_desc)
61                break
62        else:
63            assert False, "Added HD key was not found in wallet"
64
65        for d in wallet.listdescriptors()["descriptors"]:
66            if d["desc"] == expected_unused_desc:
67                assert_equal(d["active"], False)
68                break
69        else:
70            assert False, "Added HD key's descriptor was not found in wallet"
71
72        assert_raises_rpc_error(-4, "HD key already exists", wallet.addhdkey, imp_xprv)
73
74    def test_addhdkey_noprivs(self):
75        self.log.info("Test addhdkey is not available for wallets without privkeys")
76        self.nodes[0].createwallet("hdkey_noprivs", disable_private_keys=True)
77        wallet = self.nodes[0].get_wallet_rpc("hdkey_noprivs")
78        assert_raises_rpc_error(-4, "addhdkey is not available for wallets without private keys", wallet.addhdkey)
79
80    def run_test(self):
81        # Make sure we use hd, keep masterkeyid
82        hd_fingerprint = self.nodes[1].getaddressinfo(self.nodes[1].getnewaddress())['hdmasterfingerprint']
83        assert_equal(len(hd_fingerprint), 8)
84
85        # create an internal key
86        change_addr = self.nodes[1].getrawchangeaddress()
87        change_addrV = self.nodes[1].getaddressinfo(change_addr)
88        assert_equal(change_addrV["hdkeypath"], "m/84h/1h/0h/1/0")
89
90        # Import a non-HD private key in the HD wallet
91        non_hd_add = 'bcrt1qmevj8zfx0wdvp05cqwkmr6mxkfx60yezwjksmt'
92        non_hd_key = 'cS9umN9w6cDMuRVYdbkfE4c7YUFLJRoXMfhQ569uY4odiQbVN8Rt'
93        wallet_importprivkey(self.nodes[1], non_hd_key, "now")
94
95        # This should be enough to keep the master key and the non-HD key
96        self.nodes[1].backupwallet(self.nodes[1].datadir_path / "hd.bak")
97
98        # Derive some HD addresses and remember the last
99        # Also send funds to each add
100        self.generate(self.nodes[0], COINBASE_MATURITY + 1)
101        hd_add = None
102        NUM_HD_ADDS = 10
103        for i in range(1, NUM_HD_ADDS + 1):
104            hd_add = self.nodes[1].getnewaddress()
105            hd_info = self.nodes[1].getaddressinfo(hd_add)
106            assert_equal(hd_info["hdkeypath"], "m/84h/1h/0h/0/" + str(i))
107            assert_equal(hd_info["hdmasterfingerprint"], hd_fingerprint)
108            self.nodes[0].sendtoaddress(hd_add, 1)
109            self.generate(self.nodes[0], 1)
110        self.nodes[0].sendtoaddress(non_hd_add, 1)
111        self.generate(self.nodes[0], 1)
112
113        # create an internal key (again)
114        change_addr = self.nodes[1].getrawchangeaddress()
115        change_addrV = self.nodes[1].getaddressinfo(change_addr)
116        assert_equal(change_addrV["hdkeypath"], "m/84h/1h/0h/1/1")
117
118        self.sync_all()
119        assert_equal(self.nodes[1].getbalance(), NUM_HD_ADDS + 1)
120
121        self.log.info("Restore backup ...")
122        self.stop_node(1)
123        # we need to delete the complete chain directory
124        # otherwise node1 would auto-recover all funds in flag the keypool keys as used
125        self.cleanup_folder(self.nodes[1].blocks_path)
126        self.cleanup_folder(self.nodes[1].chain_path / "chainstate")
127        shutil.copyfile(
128            self.nodes[1].datadir_path / "hd.bak",
129            self.nodes[1].wallets_path / self.default_wallet_name / self.wallet_data_filename
130        )
131        self.start_node(1)
132
133        # Assert that derivation is deterministic
134        hd_add_2 = None
135        for i in range(1, NUM_HD_ADDS + 1):
136            hd_add_2 = self.nodes[1].getnewaddress()
137            hd_info_2 = self.nodes[1].getaddressinfo(hd_add_2)
138            assert_equal(hd_info_2["hdkeypath"], "m/84h/1h/0h/0/" + str(i))
139            assert_equal(hd_info_2["hdmasterfingerprint"], hd_fingerprint)
140        assert_equal(hd_add, hd_add_2)
141        self.connect_nodes(0, 1)
142        self.sync_all()
143
144        # Needs rescan
145        self.nodes[1].rescanblockchain()
146        assert_equal(self.nodes[1].getbalance(), NUM_HD_ADDS + 1)
147
148        # Try a RPC based rescan
149        self.stop_node(1)
150        self.cleanup_folder(self.nodes[1].blocks_path)
151        self.cleanup_folder(self.nodes[1].chain_path / "chainstate")
152        shutil.copyfile(
153            self.nodes[1].datadir_path / "hd.bak",
154            self.nodes[1].wallets_path / self.default_wallet_name / self.wallet_data_filename
155        )
156        self.start_node(1, extra_args=self.extra_args[1])
157        self.connect_nodes(0, 1)
158        self.sync_all()
159        # Wallet automatically scans blocks older than key on startup
160        assert_equal(self.nodes[1].getbalance(), NUM_HD_ADDS + 1)
161        out = self.nodes[1].rescanblockchain(0, 1)
162        assert_equal(out['start_height'], 0)
163        assert_equal(out['stop_height'], 1)
164        out = self.nodes[1].rescanblockchain()
165        assert_equal(out['start_height'], 0)
166        assert_equal(out['stop_height'], self.nodes[1].getblockcount())
167        assert_equal(self.nodes[1].getbalance(), NUM_HD_ADDS + 1)
168
169        # send a tx and make sure its using the internal chain for the changeoutput
170        txid = self.nodes[1].sendtoaddress(self.nodes[0].getnewaddress(), 1)
171        outs = self.nodes[1].gettransaction(txid=txid, verbose=True)['decoded']['vout']
172        keypath = ""
173        for out in outs:
174            if out['value'] != 1:
175                keypath = self.nodes[1].getaddressinfo(out['scriptPubKey']['address'])['hdkeypath']
176
177        assert_equal(keypath[0:14], "m/84h/1h/0h/1/")
178
179        self.test_addhdkey()
180        self.test_addhdkey_noprivs()
181
182if __name__ == '__main__':
183    WalletHDTest(__file__).main()
184

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.