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.

8,814 bytes · SHA-256 42f13b9b02ed7357… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2014-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 the listdescriptors RPC."""
6
7from test_framework.blocktools import (
8    TIME_GENESIS_BLOCK,
9)
10from test_framework.descriptors import (
11    descsum_create,
12)
13from test_framework.extendedkey import ExtendedPrivateKey
14from test_framework.test_framework import BitcoinTestFramework
15from test_framework.util import (
16    assert_not_equal,
17    assert_equal,
18    assert_raises_rpc_error,
19)
20from test_framework.wallet_util import generate_keypair
21
22
23class ListDescriptorsTest(BitcoinTestFramework):
24    def set_test_params(self):
25        self.num_nodes = 1
26
27    def skip_test_if_missing_module(self):
28        self.skip_if_no_wallet()
29
30    # do not create any wallet by default
31    def init_wallet(self, *, node):
32        return
33
34    def run_test(self):
35        node = self.nodes[0]
36        assert_raises_rpc_error(-18, 'No wallet is loaded.', node.listdescriptors)
37
38        self.log.info('Test the command for empty descriptors wallet.')
39        node.createwallet(wallet_name='w2', blank=True)
40        assert_equal(0, len(node.get_wallet_rpc('w2').listdescriptors()['descriptors']))
41
42        self.log.info('Test the command for a default descriptors wallet.')
43        node.createwallet(wallet_name='w3')
44        result = node.get_wallet_rpc('w3').listdescriptors()
45        assert_equal("w3", result['wallet_name'])
46        assert_equal(8, len(result['descriptors']))
47        assert_equal(8, len([d for d in result['descriptors'] if d['active']]))
48        assert_equal(4, len([d for d in result['descriptors'] if d['internal']]))
49        for item in result['descriptors']:
50            assert_not_equal(item['desc'], '')
51            assert_equal(item['next_index'], 0)
52            assert_equal(item['range'], [0, 0])
53            assert item['timestamp'] is not None
54
55        self.log.info('Test that descriptor strings are returned in lexicographically sorted order.')
56        descriptor_strings = [descriptor['desc'] for descriptor in result['descriptors']]
57        assert_equal(descriptor_strings, sorted(descriptor_strings))
58
59        self.log.info('Test descriptors with hardened derivations are listed in importable form.')
60        extended_key = ExtendedPrivateKey.generate()
61        xprv = extended_key.to_string()
62        xprv_fingerprint = extended_key._fingerprint().hex()
63        hardened_path = '/84h/1h/0h'
64        xpub_acc = extended_key.derive_path(f"m{hardened_path}").pubkey().to_string()
65        wallet = node.get_wallet_rpc('w2')
66        wallet.importdescriptors([{
67            'desc': descsum_create('wpkh(' + xprv + hardened_path + '/0/*)'),
68            'timestamp': TIME_GENESIS_BLOCK,
69        }])
70        expected = {
71            'wallet_name': 'w2',
72            'descriptors': [
73                {'desc': descsum_create('wpkh([' + xprv_fingerprint + hardened_path + ']' + xpub_acc + '/0/*)'),
74                 'timestamp': TIME_GENESIS_BLOCK,
75                 'active': False,
76                 'range': [0, 0],
77                 'next': 0,
78                 'next_index': 0},
79            ],
80        }
81        assert_equal(expected, wallet.listdescriptors())
82        assert_equal(expected, wallet.listdescriptors(False))
83
84        self.log.info('Test list private descriptors')
85        expected_private = {
86            'wallet_name': 'w2',
87            'descriptors': [
88                {'desc': descsum_create('wpkh(' + xprv + hardened_path + '/0/*)'),
89                 'timestamp': TIME_GENESIS_BLOCK,
90                 'active': False,
91                 'range': [0, 0],
92                 'next': 0,
93                 'next_index': 0},
94            ],
95        }
96        assert_equal(expected_private, wallet.listdescriptors(True))
97
98        self.log.info("Test listdescriptors with encrypted wallet")
99        wallet.encryptwallet("pass")
100        assert_equal(expected, wallet.listdescriptors())
101
102        self.log.info('Test list private descriptors with encrypted wallet')
103        assert_raises_rpc_error(-13, 'Please enter the wallet passphrase with walletpassphrase first.', wallet.listdescriptors, True)
104        wallet.walletpassphrase(passphrase="pass", timeout=1000000)
105        assert_equal(expected_private, wallet.listdescriptors(True))
106
107        self.log.info('Test list private descriptors with watch-only wallet')
108        node.createwallet(wallet_name='watch-only', disable_private_keys=True)
109        watch_only_wallet = node.get_wallet_rpc('watch-only')
110        watch_only_wallet.importdescriptors([{
111            'desc': descsum_create('wpkh(' + xpub_acc + ')'),
112            'timestamp': TIME_GENESIS_BLOCK,
113        }])
114        assert_raises_rpc_error(-4, 'Can\'t get private descriptor string for watch-only wallets', watch_only_wallet.listdescriptors, True)
115
116        self.log.info('Test non-active non-range combo descriptor')
117        node.createwallet(wallet_name='w4', blank=True)
118        wallet = node.get_wallet_rpc('w4')
119        wallet.importdescriptors([{
120            'desc': descsum_create('combo(' + node.get_deterministic_priv_key().key + ')'),
121            'timestamp': TIME_GENESIS_BLOCK,
122        }])
123        expected = {
124            'wallet_name': 'w4',
125            'descriptors': [
126                {'active': False,
127                 'desc': 'combo(0227d85ba011276cf25b51df6a188b75e604b38770a462b2d0e9fb2fc839ef5d3f)#np574htj',
128                 'timestamp': TIME_GENESIS_BLOCK},
129            ],
130        }
131        assert_equal(expected, wallet.listdescriptors())
132
133        self.log.info('Test taproot descriptor do not have mixed hardened derivation marker')
134        node.createwallet(wallet_name='w5', descriptors=True, disable_private_keys=True)
135        wallet = node.get_wallet_rpc('w5')
136        derivation_path = "/48'/1'/0'/2'"
137        xprvs = [ExtendedPrivateKey.generate() for _ in range(0, 2)]
138        xprv_fingerprints = [xprv._fingerprint().hex() for xprv in xprvs]
139        desc_xpubs = [xprv.derive_path(f"m{derivation_path}").pubkey().to_string() for xprv in xprvs]
140        wallet.importdescriptors([{
141            'desc': descsum_create(f"tr([{xprv_fingerprints[0]}{derivation_path}]{desc_xpubs[0]}/0/*,and_v(v:pk([{xprv_fingerprints[1]}{derivation_path}]{desc_xpubs[1]}/0/*),older(65535)))"),
142            'timestamp': TIME_GENESIS_BLOCK,
143        }])
144        derivation_path_alternate = "/48h/1h/0h/2h"
145        expected = {
146            'wallet_name': 'w5',
147            'descriptors': [
148                {'active': False,
149                 'desc': descsum_create(f'tr([{xprv_fingerprints[0]}{derivation_path_alternate}]{desc_xpubs[0]}/0/*,and_v(v:pk([{xprv_fingerprints[1]}{derivation_path_alternate}]{desc_xpubs[1]}/0/*),older(65535)))'),
150                 'timestamp': TIME_GENESIS_BLOCK,
151                 'range': [0, 0],
152                 'next': 0,
153                 'next_index': 0},
154            ]
155        }
156        assert_equal(expected, wallet.listdescriptors())
157
158        self.log.info('Test descriptor with missing private keys')
159        node.createwallet(wallet_name='w6', blank=True)
160        wallet = node.get_wallet_rpc('w6')
161
162        xprvs = []
163        xpubs = []
164        for _ in range(0, 8):
165            xprvs.append(ExtendedPrivateKey.generate().to_string())
166            xpubs.append(ExtendedPrivateKey.generate().pubkey().to_string())
167
168        _, pubkey_bytes = generate_keypair()
169        pubkey = pubkey_bytes.hex()
170
171        expected_descs = {
172            descsum_create(f'tr({node.get_deterministic_priv_key().key},{{pk({pubkey}),pk([d34db33f/44h/0h/0h]{xpubs[0]}/0)}})'),
173            descsum_create(f'wsh(and_v(v:ripemd160(095ff41131e5946f3c85f79e44adbcf8e27e080e),multi(1,{node.get_deterministic_priv_key().key},{xpubs[1]}/0)))'),
174            descsum_create(f'tr({pubkey},pk(musig({xprvs[0]},{xpubs[2]})/7/8/*))'),
175            descsum_create(f'tr({pubkey},pk(musig({xprvs[1]}/10,{xpubs[3]}/11)/*))'),
176            descsum_create(f'tr({pubkey},{{pk(musig({xpubs[4]},{xprvs[2]})/12/*),pk(musig({xprvs[3]},{xpubs[4]})/13/*)}})'),
177            descsum_create(f'tr({pubkey},{{pk(musig({xpubs[5]},{xpubs[6]})/12/*),pk(musig({xprvs[4]},{xpubs[7]})/13/*)}})')
178        }
179
180        descs_to_import = []
181        for desc in expected_descs:
182            descs_to_import.append({'desc': desc, 'timestamp': TIME_GENESIS_BLOCK})
183
184        wallet.importdescriptors(descs_to_import)
185        result = wallet.listdescriptors(True)
186        actual_descs = [d['desc'] for d in result['descriptors']]
187
188        assert_equal(len(actual_descs), len(expected_descs))
189        for desc in actual_descs:
190            if desc not in expected_descs:
191                raise AssertionError(f"{desc} missing")
192
193
194
195if __name__ == '__main__':
196    ListDescriptorsTest(__file__).main()
197

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.