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.

9,096 bytes · SHA-256 939aeb1e052565d4… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2023-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 wallet gethdkeys RPC."""
6
7from test_framework.descriptors import descsum_create
8from test_framework.test_framework import BitcoinTestFramework
9from test_framework.util import (
10    assert_equal,
11    assert_raises_rpc_error,
12    assert_not_equal,
13    assert_greater_than,
14)
15from test_framework.wallet_util import WalletUnlock
16
17
18class WalletGetHDKeyTest(BitcoinTestFramework):
19    def set_test_params(self):
20        self.setup_clean_chain = True
21        self.num_nodes = 1
22
23    def skip_test_if_missing_module(self):
24        self.skip_if_no_wallet()
25
26    def run_test(self):
27        self.test_basic_gethdkeys()
28        self.test_ranged_imports()
29        self.test_lone_key_imports()
30        self.test_ranged_multisig()
31        self.test_mixed_multisig()
32
33    def test_basic_gethdkeys(self):
34        self.log.info("Test gethdkeys basics")
35        self.nodes[0].createwallet("basic")
36        wallet = self.nodes[0].get_wallet_rpc("basic")
37        xpub_info = wallet.gethdkeys()
38        assert_equal(len(xpub_info), 1)
39        assert_equal(xpub_info[0]["has_private"], True)
40
41        assert "xprv" not in xpub_info[0]
42        xpub = xpub_info[0]["xpub"]
43
44        xpub_info = wallet.gethdkeys(private=True)
45        xprv = xpub_info[0]["xprv"]
46        assert_equal(xpub_info[0]["xpub"], xpub)
47        assert_equal(xpub_info[0]["has_private"], True)
48
49        descs = wallet.listdescriptors(True)
50        for desc in descs["descriptors"]:
51            assert xprv in desc["desc"]
52
53        self.log.info("HD pubkey can be retrieved from encrypted wallets")
54        prev_xprv = xprv
55        wallet.encryptwallet("pass")
56        # HD key is rotated on encryption, there should now be 2 HD keys
57        assert_equal(len(wallet.gethdkeys()), 2)
58        # New key is active, should be able to get only that one and its descriptors
59        xpub_info = wallet.gethdkeys(active_only=True)
60        assert_equal(len(xpub_info), 1)
61        assert_not_equal(xpub_info[0]["xpub"], xpub)
62        assert "xprv" not in xpub_info[0]
63        assert_equal(xpub_info[0]["has_private"], True)
64
65        self.log.info("HD privkey can be retrieved from encrypted wallets")
66        assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first", wallet.gethdkeys, private=True)
67        with WalletUnlock(wallet, "pass"):
68            xpub_info = wallet.gethdkeys(active_only=True, private=True)[0]
69            assert_not_equal(xpub_info["xprv"], xprv)
70            for desc in wallet.listdescriptors(True)["descriptors"]:
71                if desc["active"]:
72                    # After encrypting, HD key was rotated and should appear in all active descriptors
73                    assert xpub_info["xprv"] in desc["desc"]
74                else:
75                    # Inactive descriptors should have the previous HD key
76                    assert prev_xprv in desc["desc"]
77
78    def test_ranged_imports(self):
79        self.log.info("Keys of imported ranged descriptors appear in gethdkeys")
80        def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
81        self.nodes[0].createwallet("imports")
82        wallet = self.nodes[0].get_wallet_rpc("imports")
83
84        xpub_info = wallet.gethdkeys()
85        assert_equal(len(xpub_info), 1)
86        active_xpub = xpub_info[0]["xpub"]
87
88        import_xpub = def_wallet.gethdkeys(active_only=True)[0]["xpub"]
89        desc_import = def_wallet.listdescriptors(True)["descriptors"]
90        for desc in desc_import:
91            desc["active"] = False
92        wallet.importdescriptors(desc_import)
93        assert_equal(wallet.gethdkeys(active_only=True), xpub_info)
94
95        xpub_info = wallet.gethdkeys()
96        assert_equal(len(xpub_info), 2)
97        for x in xpub_info:
98            if x["xpub"] == active_xpub:
99                for desc in x["descriptors"]:
100                    assert_equal(desc["active"], True)
101            elif x["xpub"] == import_xpub:
102                for desc in x["descriptors"]:
103                    assert_equal(desc["active"], False)
104            else:
105                assert False
106
107
108    def test_lone_key_imports(self):
109        self.log.info("Non-HD keys do not appear in gethdkeys")
110        self.nodes[0].createwallet("lonekey", blank=True)
111        wallet = self.nodes[0].get_wallet_rpc("lonekey")
112
113        assert_equal(wallet.gethdkeys(), [])
114        wallet.importdescriptors([{"desc": descsum_create("wpkh(cTe1f5rdT8A8DFgVWTjyPwACsDPJM9ff4QngFxUixCSvvbg1x6sh)"), "timestamp": "now"}])
115        assert_equal(wallet.gethdkeys(), [])
116
117        self.log.info("HD keys of non-ranged descriptors should appear in gethdkeys")
118        def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
119        xpub_info = def_wallet.gethdkeys(private=True)
120        xpub = xpub_info[0]["xpub"]
121        xprv = xpub_info[0]["xprv"]
122        prv_desc = descsum_create(f"wpkh({xprv})")
123        pub_desc = descsum_create(f"wpkh({xpub})")
124        assert_equal(wallet.importdescriptors([{"desc": prv_desc, "timestamp": "now"}])[0]["success"], True)
125        xpub_info = wallet.gethdkeys()
126        assert_equal(len(xpub_info), 1)
127        assert_equal(xpub_info[0]["xpub"], xpub)
128        assert_equal(len(xpub_info[0]["descriptors"]), 1)
129        assert_equal(xpub_info[0]["descriptors"][0]["desc"], pub_desc)
130        assert_equal(xpub_info[0]["descriptors"][0]["active"], False)
131
132    def test_ranged_multisig(self):
133        self.log.info("HD keys of a multisig appear in gethdkeys")
134
135        def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
136        outside_wallet_xpub = def_wallet.gethdkeys()[0]["xpub"]
137
138        self.nodes[0].createwallet("ranged_multisig")
139        wallet = self.nodes[0].get_wallet_rpc("ranged_multisig")
140
141        hdkeys_info = wallet.gethdkeys(private=True)
142        assert_equal(len(hdkeys_info), 1)
143        within_wallet_xprv = hdkeys_info[0]["xprv"]
144        within_wallet_xpub = hdkeys_info[0]["xpub"]
145
146        prv_multi_desc = descsum_create(f"wsh(multi(2,{within_wallet_xprv}/*,{outside_wallet_xpub}/*))")
147        pub_multi_desc = descsum_create(f"wsh(multi(2,{within_wallet_xpub}/*,{outside_wallet_xpub}/*))")
148        assert_equal(wallet.importdescriptors([{"desc": prv_multi_desc, "timestamp": "now"}])[0]["success"], True)
149
150        rpcs_req_resp = [[False, wallet.gethdkeys()], [True, wallet.gethdkeys(private=True)]]
151        for rpc_req_resp in rpcs_req_resp:
152            requested_private, hdkeys_response = rpc_req_resp
153            assert_equal(len(hdkeys_response), 2)
154
155            for hdkeys_info in hdkeys_response:
156                if hdkeys_info["xpub"] == within_wallet_xpub:
157                    assert_equal(hdkeys_info["has_private"], True)
158                    if requested_private:
159                        assert_equal(hdkeys_info["xprv"], within_wallet_xprv)
160                    else:
161                        assert_equal("xprv" not in hdkeys_info, True)
162                    assert_greater_than(len(hdkeys_info["descriptors"]), 1) # within wallet xpub by default is part of multiple descriptors
163                    found_desc = next((d for d in hdkeys_info["descriptors"] if d["desc"] == pub_multi_desc), None)
164                elif hdkeys_info["xpub"] == outside_wallet_xpub:
165                    assert_equal(hdkeys_info["has_private"], False)
166                    assert_equal("xprv" not in hdkeys_info, True)
167                    assert_equal(len(hdkeys_info["descriptors"]), 1) # outside wallet xpub is part of only the imported descriptor
168                    found_desc = hdkeys_info["descriptors"][0]
169                else:
170                    assert False
171
172                assert_equal(found_desc["desc"], pub_multi_desc)
173                assert_equal(found_desc["active"], False)
174
175    def test_mixed_multisig(self):
176        self.log.info("Non-HD keys of a multisig do not appear in gethdkeys")
177        def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
178        self.nodes[0].createwallet("single_multisig")
179        wallet = self.nodes[0].get_wallet_rpc("single_multisig")
180
181        xpub = wallet.gethdkeys()[0]["xpub"]
182        xprv = wallet.gethdkeys(private=True)[0]["xprv"]
183        pub = def_wallet.getaddressinfo(def_wallet.getnewaddress())["pubkey"]
184
185        prv_multi_desc = descsum_create(f"wsh(multi(2,{xprv},{pub}))")
186        pub_multi_desc = descsum_create(f"wsh(multi(2,{xpub},{pub}))")
187        import_res = wallet.importdescriptors([{"desc": prv_multi_desc, "timestamp": "now"}])
188        assert_equal(import_res[0]["success"], True)
189
190        xpub_info = wallet.gethdkeys()
191        assert_equal(len(xpub_info), 1)
192        assert_equal(xpub_info[0]["xpub"], xpub)
193        found_desc = next((d for d in xpub_info[0]["descriptors"] if d["desc"] == pub_multi_desc), None)
194        assert found_desc is not None
195        assert_equal(found_desc["active"], False)
196
197
198if __name__ == '__main__':
199    WalletGetHDKeyTest(__file__).main()
200

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.