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.

13,717 bytes · SHA-256 bb3df756a9b1dfb3… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2019-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 descriptor wallet function."""
6
7try:
8    import sqlite3
9except ImportError:
10    pass
11
12import re
13
14from test_framework.blocktools import COINBASE_MATURITY
15from test_framework.descriptors import descsum_create
16from test_framework.extendedkey import ExtendedPrivateKey
17from test_framework.messages import ser_string
18from test_framework.test_framework import BitcoinTestFramework
19from test_framework.util import (
20    assert_not_equal,
21    assert_equal,
22    assert_raises_rpc_error
23)
24from test_framework.wallet_util import WalletUnlock
25
26
27class WalletDescriptorTest(BitcoinTestFramework):
28    def set_test_params(self):
29        self.setup_clean_chain = True
30        self.num_nodes = 1
31        self.extra_args = [['-keypool=100']]
32
33    def skip_test_if_missing_module(self):
34        self.skip_if_no_wallet()
35        self.skip_if_no_py_sqlite3()
36
37    def test_parent_descriptors(self):
38        self.log.info("Check that parent_descs is the same for all RPCs and is normalized")
39        self.nodes[0].createwallet(wallet_name="parent_descs")
40        wallet = self.nodes[0].get_wallet_rpc("parent_descs")
41        default_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
42
43        addr = wallet.getnewaddress()
44        parent_desc = wallet.getaddressinfo(addr)["parent_desc"]
45
46        # Verify that the parent descriptor is normalized
47        # First remove the checksum
48        desc_verify = parent_desc.split("#")[0]
49        # Next extract the xpub
50        desc_verify = re.sub(r"tpub\w+?(?=/)", "", desc_verify)
51        # Extract origin info
52        origin_match = re.search(r'\[([\da-fh/]+)\]', desc_verify)
53        origin_part = origin_match.group(1) if origin_match else ""
54        # Split on "]" for everything after the origin info
55        after_origin = desc_verify.split("]", maxsplit=1)[-1]
56        # Look for the hardened markers “h” inside each piece
57        # We don't need to check for aspostrophe as normalization will not output aspostrophe
58        found_hardened_in_origin = "h" in origin_part
59        found_hardened_after_origin = "h" in after_origin
60        assert_equal(found_hardened_in_origin, True)
61        assert_equal(found_hardened_after_origin, False)
62
63        # Send some coins so we can check listunspent, listtransactions, listunspent, and gettransaction
64        since_block = self.nodes[0].getbestblockhash()
65        txid = default_wallet.sendtoaddress(addr, 1)
66        self.generate(self.nodes[0], 1)
67
68        unspent = wallet.listunspent()
69        assert_equal(len(unspent), 1)
70        assert_equal(unspent[0]["parent_descs"], [parent_desc])
71
72        txs = wallet.listtransactions()
73        assert_equal(len(txs), 1)
74        assert_equal(txs[0]["parent_descs"], [parent_desc])
75
76        txs = wallet.listsinceblock(since_block)["transactions"]
77        assert_equal(len(txs), 1)
78        assert_equal(txs[0]["parent_descs"], [parent_desc])
79
80        tx = wallet.gettransaction(txid=txid, verbose=True)
81        assert_equal(tx["details"][0]["parent_descs"], [parent_desc])
82
83        wallet.unloadwallet()
84
85    def run_test(self):
86        self.generate(self.nodes[0], COINBASE_MATURITY + 1)
87
88        # Make a descriptor wallet
89        self.log.info("Making a descriptor wallet")
90        self.nodes[0].createwallet(wallet_name="desc1")
91        wallet = self.nodes[0].get_wallet_rpc("desc1")
92
93        # A descriptor wallet should have 100 addresses * 4 types = 400 keys
94        self.log.info("Checking wallet info")
95        wallet_info = wallet.getwalletinfo()
96        assert_equal(wallet_info['format'], 'sqlite')
97        assert_equal(wallet_info['keypoolsize'], 400)
98        assert_equal(wallet_info['keypoolsize_hd_internal'], 400)
99        assert 'keypoololdest' not in wallet_info
100
101        # Check that getnewaddress works
102        self.log.info("Test that getnewaddress and getrawchangeaddress work")
103        addr = wallet.getnewaddress("", "legacy")
104        addr_info = wallet.getaddressinfo(addr)
105        assert addr_info['desc'].startswith('pkh(')
106        assert_equal(addr_info['hdkeypath'], 'm/44h/1h/0h/0/0')
107
108        addr = wallet.getnewaddress("", "p2sh-segwit")
109        addr_info = wallet.getaddressinfo(addr)
110        assert addr_info['desc'].startswith('sh(wpkh(')
111        assert_equal(addr_info['hdkeypath'], 'm/49h/1h/0h/0/0')
112
113        addr = wallet.getnewaddress("", "bech32")
114        addr_info = wallet.getaddressinfo(addr)
115        assert addr_info['desc'].startswith('wpkh(')
116        assert_equal(addr_info['hdkeypath'], 'm/84h/1h/0h/0/0')
117
118        addr = wallet.getnewaddress("", "bech32m")
119        addr_info = wallet.getaddressinfo(addr)
120        assert addr_info['desc'].startswith('tr(')
121        assert_equal(addr_info['hdkeypath'], 'm/86h/1h/0h/0/0')
122
123        # Check that getrawchangeaddress works
124        addr = wallet.getrawchangeaddress("legacy")
125        addr_info = wallet.getaddressinfo(addr)
126        assert addr_info['desc'].startswith('pkh(')
127        assert_equal(addr_info['hdkeypath'], 'm/44h/1h/0h/1/0')
128
129        addr = wallet.getrawchangeaddress("p2sh-segwit")
130        addr_info = wallet.getaddressinfo(addr)
131        assert addr_info['desc'].startswith('sh(wpkh(')
132        assert_equal(addr_info['hdkeypath'], 'm/49h/1h/0h/1/0')
133
134        addr = wallet.getrawchangeaddress("bech32")
135        addr_info = wallet.getaddressinfo(addr)
136        assert addr_info['desc'].startswith('wpkh(')
137        assert_equal(addr_info['hdkeypath'], 'm/84h/1h/0h/1/0')
138
139        addr = wallet.getrawchangeaddress("bech32m")
140        addr_info = wallet.getaddressinfo(addr)
141        assert addr_info['desc'].startswith('tr(')
142        assert_equal(addr_info['hdkeypath'], 'm/86h/1h/0h/1/0')
143
144        # Make a wallet to receive coins at
145        self.nodes[0].createwallet(wallet_name="desc2")
146        recv_wrpc = self.nodes[0].get_wallet_rpc("desc2")
147        send_wrpc = self.nodes[0].get_wallet_rpc("desc1")
148
149        # Generate some coins
150        self.generatetoaddress(self.nodes[0], COINBASE_MATURITY + 1, send_wrpc.getnewaddress())
151
152        # Make transactions
153        self.log.info("Test sending and receiving")
154        addr = recv_wrpc.getnewaddress()
155        send_wrpc.sendtoaddress(addr, 10)
156
157        self.log.info("Test encryption")
158        # Get the master fingerprint before encrypt
159        info1 = send_wrpc.getaddressinfo(send_wrpc.getnewaddress())
160
161        # Encrypt wallet 0
162        send_wrpc.encryptwallet('pass')
163        with WalletUnlock(send_wrpc, "pass"):
164            addr = send_wrpc.getnewaddress()
165            info2 = send_wrpc.getaddressinfo(addr)
166            assert_not_equal(info1['hdmasterfingerprint'], info2['hdmasterfingerprint'])
167        assert 'hdmasterfingerprint' in send_wrpc.getaddressinfo(send_wrpc.getnewaddress())
168        info3 = send_wrpc.getaddressinfo(addr)
169        assert_equal(info2['desc'], info3['desc'])
170
171        self.log.info("Test that getnewaddress still works after keypool is exhausted in an encrypted wallet")
172        for _ in range(500):
173            send_wrpc.getnewaddress()
174
175        self.log.info("Test that unlock is needed when deriving only hardened keys in an encrypted wallet")
176        with WalletUnlock(send_wrpc, "pass"):
177            send_wrpc.importdescriptors([{
178                "desc": descsum_create(f"wpkh({ExtendedPrivateKey.generate().to_string()}/0h/*h)"),
179                "timestamp": "now",
180                "range": [0,10],
181                "active": True
182            }])
183        # Exhaust keypool of 100
184        for _ in range(100):
185            send_wrpc.getnewaddress(address_type='bech32')
186        # This should now error
187        assert_raises_rpc_error(-12, "Keypool ran out, please call keypoolrefill first", send_wrpc.getnewaddress, '', 'bech32')
188
189        self.log.info("Test born encrypted wallets")
190        self.nodes[0].createwallet('desc_enc', False, False, 'pass', False, True)
191        enc_rpc = self.nodes[0].get_wallet_rpc('desc_enc')
192        enc_rpc.getnewaddress() # Makes sure that we can get a new address from a born encrypted wallet
193
194        self.log.info("Test blank descriptor wallets")
195        self.nodes[0].createwallet(wallet_name='desc_blank', blank=True)
196        blank_rpc = self.nodes[0].get_wallet_rpc('desc_blank')
197        assert_raises_rpc_error(-4, 'This wallet has no available keys', blank_rpc.getnewaddress)
198
199        self.log.info("Test descriptor wallet with disabled private keys")
200        self.nodes[0].createwallet(wallet_name='desc_no_priv', disable_private_keys=True)
201        nopriv_rpc = self.nodes[0].get_wallet_rpc('desc_no_priv')
202        assert_raises_rpc_error(-4, 'This wallet has no available keys', nopriv_rpc.getnewaddress)
203
204        self.log.info("Test descriptor exports")
205        self.nodes[0].createwallet(wallet_name='desc_export')
206        exp_rpc = self.nodes[0].get_wallet_rpc('desc_export')
207        self.nodes[0].createwallet(wallet_name='desc_import', disable_private_keys=True)
208        imp_rpc = self.nodes[0].get_wallet_rpc('desc_import')
209
210        addr_types = [('legacy', False, 'pkh(', '44h/1h/0h', -13),
211                      ('p2sh-segwit', False, 'sh(wpkh(', '49h/1h/0h', -14),
212                      ('bech32', False, 'wpkh(', '84h/1h/0h', -13),
213                      ('bech32m', False, 'tr(', '86h/1h/0h', -13),
214                      ('legacy', True, 'pkh(', '44h/1h/0h', -13),
215                      ('p2sh-segwit', True, 'sh(wpkh(', '49h/1h/0h', -14),
216                      ('bech32', True, 'wpkh(', '84h/1h/0h', -13),
217                      ('bech32m', True, 'tr(', '86h/1h/0h', -13)]
218
219        for addr_type, internal, desc_prefix, deriv_path, int_idx in addr_types:
220            int_str = 'internal' if internal else 'external'
221
222            self.log.info("Testing descriptor address type for {} {}".format(addr_type, int_str))
223            if internal:
224                addr = exp_rpc.getrawchangeaddress(address_type=addr_type)
225            else:
226                addr = exp_rpc.getnewaddress(address_type=addr_type)
227            desc = exp_rpc.getaddressinfo(addr)['parent_desc']
228            assert_equal(desc_prefix, desc[0:len(desc_prefix)])
229            idx = desc.index('/') + 1
230            assert_equal(deriv_path, desc[idx:idx + 9])
231            if internal:
232                assert_equal('1', desc[int_idx])
233            else:
234                assert_equal('0', desc[int_idx])
235
236            self.log.info("Testing the same descriptor is returned for address type {} {}".format(addr_type, int_str))
237            for i in range(0, 10):
238                if internal:
239                    addr = exp_rpc.getrawchangeaddress(address_type=addr_type)
240                else:
241                    addr = exp_rpc.getnewaddress(address_type=addr_type)
242                test_desc = exp_rpc.getaddressinfo(addr)['parent_desc']
243                assert_equal(desc, test_desc)
244
245            self.log.info("Testing import of exported {} descriptor".format(addr_type))
246            imp_rpc.importdescriptors([{
247                'desc': desc,
248                'active': True,
249                'next_index': 11,
250                'timestamp': 'now',

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.