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,364 bytes · SHA-256 3ea01b8b2cb41478… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2025-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 derivehdkey RPC."""
6
7from test_framework.test_framework import BitcoinTestFramework
8from test_framework.util import (
9    assert_equal,
10    assert_raises_rpc_error,
11)
12from test_framework.wallet_util import WalletUnlock
13
14
15class WalletDeriveHDKeyTest(BitcoinTestFramework):
16    def set_test_params(self):
17        self.setup_clean_chain = True
18        self.num_nodes = 2
19
20    def skip_test_if_missing_module(self):
21        self.skip_if_no_wallet()
22
23    def run_test(self):
24        self.test_basic_derivehdkey()
25        self.test_multiple_unused_keys()
26        self.test_active_descriptor()
27        self.test_inactive_descriptor()
28        self.test_noprivs_blank()
29        self.test_compare()
30
31    def test_basic_derivehdkey(self):
32        self.log.info("Test derivehdkey basics")
33        self.nodes[0].createwallet("basic", blank=True)
34        wallet = self.nodes[0].get_wallet_rpc("basic")
35        assert_raises_rpc_error(
36            -8,
37            "Derivation path requires at least one hardened step",
38            wallet.derivehdkey,
39            "m",
40        )
41        assert_raises_rpc_error(
42            -8,
43            "Derivation path requires at least one hardened step",
44            wallet.derivehdkey,
45            "m/87/0/0",
46        )
47        # A BIP32 keypath element must be in 0..2^31-1. The
48        # value 2^31 (2147483648 == 0x80000000) is out of range.
49        for path in ["m/2147483648", "m/2147483648h", "m/2147483648'"]:
50            assert_raises_rpc_error(
51                -8,
52                "Invalid BIP32 keypath",
53                wallet.derivehdkey,
54                path,
55            )
56        assert_raises_rpc_error(
57            -5,
58            "No active or unused(KEY) descriptor found",
59            wallet.derivehdkey,
60            "m/87h",
61        )
62        wallet.addhdkey()
63        xpub_info = wallet.derivehdkey("m/87h")
64        assert "xprv" not in xpub_info
65        xpub = xpub_info["xpub"]
66        root_fingerprint = wallet.derivehdkey("m/87h/0h")["origin"][1:9]
67        assert_equal(xpub_info["origin"], f"[{root_fingerprint}/87h]")
68        too_deep_path = "m/" + "/".join(["0h"] * 256)
69        assert_raises_rpc_error(
70            -8,
71            "Unable to derive HD key at the requested path",
72            wallet.derivehdkey,
73            too_deep_path,
74        )
75
76        xpub_info = wallet.derivehdkey("m/87h/0h/0h/0")
77        xpub_priv_info = wallet.derivehdkey("m/87h/0h/0h/0", private=True)
78        xprv = xpub_priv_info["xprv"]
79        assert_equal(xpub_priv_info["xpub"], xpub_info["xpub"])
80
81        self.log.info("HD pubkey can be retrieved from encrypted wallets")
82        prev_xprv = xprv
83        wallet.encryptwallet("pass")
84        assert_raises_rpc_error(
85            -13,
86            "Error: Please enter the wallet passphrase with walletpassphrase first",
87            wallet.derivehdkey,
88            "m/87h",
89        )
90        with WalletUnlock(wallet, "pass"):
91            xpub_info = wallet.derivehdkey("m/87h")
92            # Only automatically generated descriptors are rotated on
93            # encryption, unused(KEY) is not.
94            assert_equal(xpub_info["xpub"], xpub)
95            assert "xprv" not in xpub_info
96
97        self.log.info("HD privkey can be retrieved from encrypted wallets")
98        assert_raises_rpc_error(
99            -13,
100            "Error: Please enter the wallet passphrase with walletpassphrase first",
101            wallet.derivehdkey,
102            "m/87h/0h/0h/0",
103            private=True,
104        )
105        with WalletUnlock(wallet, "pass"):
106            xpub_info = wallet.derivehdkey("m/87h/0h/0h/0", private=True)
107            # Unused(KEY) is preferred over active descriptors and is not
108            # rotated on encryption.
109            assert_equal(xpub_info["xprv"], prev_xprv)
110
111    def test_multiple_unused_keys(self):
112        self.log.info("Test multiple unused(KEY) descriptors")
113        self.nodes[0].createwallet("multiple_unused_keys", blank=True)
114        wallet = self.nodes[0].get_wallet_rpc("multiple_unused_keys")
115        master_xpub_1 = wallet.addhdkey()['xpub']
116        master_xpub_2 = wallet.addhdkey()['xpub']
117        assert_raises_rpc_error(
118            -5,
119            "Unable to determine which HD key to use. Please specify with 'hdkey'",
120            wallet.derivehdkey,
121            "m/87h",
122        )
123        xpub_info_1 = wallet.derivehdkey("m/87h", hdkey=master_xpub_1)
124        xpub_info_2 = wallet.derivehdkey("m/87h", hdkey=master_xpub_2)
125        assert xpub_info_1["xpub"] != xpub_info_2["xpub"]
126
127        assert_raises_rpc_error(
128            -5,
129            "Unable to parse HD key. Please provide a valid xpub",
130            wallet.derivehdkey,
131            "m/87h",
132            hdkey="bad",
133        )
134
135    def test_active_descriptor(self):
136        self.log.info("Test derivation in wallet with regular descriptors")
137        self.nodes[0].createwallet("active_descriptor")
138        wallet = self.nodes[0].get_wallet_rpc("active_descriptor")
139        xpub_info = wallet.derivehdkey("m/44h/1h/0h")
140        active_xpub = wallet.gethdkeys(active_only=True)[0]["xpub"]
141        assert_equal(wallet.derivehdkey("m/44h/1h/0h", hdkey=active_xpub), xpub_info)
142
143        # Get the activate wpkh() receive descriptor
144        desc = list(filter(lambda d:
145                           d["active"] and not d["internal"] and d["desc"][0:3] == "pkh",
146                           wallet.listdescriptors()["descriptors"])
147                    )[0]["desc"]
148        self.log.debug(desc)
149
150        assert(xpub_info["origin"] in desc)
151        assert(xpub_info["xpub"] in desc)
152
153        self.log.info("Test unused(KEY) descriptors are preferred over active descriptors")
154        master_xpub = wallet.addhdkey()["xpub"]
155        assert_equal(
156            wallet.derivehdkey("m/87h", hdkey=master_xpub)["xpub"],
157            wallet.derivehdkey("m/87h")["xpub"],
158        )
159
160    def test_inactive_descriptor(self):
161        self.log.info("Test that the HD key of a used inactive descriptor is rejected")
162        # Mint a spendable descriptor in a throwaway wallet, so we can import it
163        # into the wallet under test and deactivate it there.
164        self.nodes[0].createwallet(wallet_name="hdkey_source")
165        source = self.nodes[0].get_wallet_rpc("hdkey_source")
166        desc = next(d["desc"] for d in source.listdescriptors(private=True)["descriptors"]
167                    if d["active"] and not d["internal"] and d["desc"].startswith("pkh("))
168
169        self.nodes[0].createwallet(wallet_name="inactive_descriptor", blank=True)
170        wallet = self.nodes[0].get_wallet_rpc("inactive_descriptor")
171        request = {"desc": desc, "range": [0, 9], "timestamp": "now", "internal": False}
172        assert_equal(wallet.importdescriptors([{**request, "active": True}])[0]["success"], True)
173
174        # While the descriptor is active its HD key can be used for derivation.
175        xpub = wallet.gethdkeys(active_only=True)[0]["xpub"]
176        wallet.derivehdkey("m/87h", hdkey=xpub)
177
178        # Once deactivated the descriptor is neither active nor unused(KEY), so
179        # its HD key is no longer a candidate.
180        assert_equal(wallet.importdescriptors([{**request, "active": False}])[0]["success"], True)
181        assert_raises_rpc_error(
182            -5,
183            "HD key is not used by an active or unused(KEY) descriptor",
184            wallet.derivehdkey,
185            "m/87h",
186            hdkey=xpub,
187        )
188
189    def test_noprivs_blank(self):
190        self.log.info("Test derivehdkey on wallet without private keys")
191        self.nodes[0].createwallet(wallet_name="noprivs", disable_private_keys=True)
192        wallet = self.nodes[0].get_wallet_rpc("noprivs")
193        assert_raises_rpc_error(
194            -4,
195            "derivehdkey is not available for watch-only wallets",
196            wallet.derivehdkey,
197            "m/87h",
198        )
199
200        self.log.info("Test derivehdkey on blank wallet")
201        self.nodes[0].createwallet(wallet_name="blank", blank=True)
202        wallet = self.nodes[0].get_wallet_rpc("blank")
203        assert_raises_rpc_error(
204            -5,
205            "No active or unused(KEY) descriptor found",
206            wallet.derivehdkey,
207            "m/87h",
208        )
209
210    def test_compare(self):
211        self.log.info(
212            "Compare with result of createwalletdescriptor")
213        self.nodes[0].createwallet(wallet_name="w1", blank=True)
214        wallet = self.nodes[0].get_wallet_rpc("w1")
215        master_xpub = wallet.addhdkey()["xpub"]
216
217        # Derive xpub for legacy descriptor
218        xpub_info = wallet.derivehdkey("m/44h/1h/0h")
219
220        # Generate legacy descriptor
221        wallet.createwalletdescriptor(type="legacy", hdkey=master_xpub)
222
223        # Get the activate wpkh() receive descriptor
224        desc = list(filter(lambda d:
225                           d["active"] and not d["internal"] and d["desc"][0:3] == "pkh",
226                           wallet.listdescriptors()["descriptors"])
227                    )[0]["desc"]
228        self.log.debug(desc)
229
230        assert(xpub_info["origin"] in desc)
231        assert(xpub_info["xpub"] in desc)
232
233
234if __name__ == '__main__':
235    WalletDeriveHDKeyTest(__file__).main()
236

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.