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.

23,762 bytes · SHA-256 f9a9881bdf46cf32… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2018-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 bitcoin-wallet."""
6
7import os
8import stat
9import subprocess
10import textwrap
11
12from collections import OrderedDict
13
14from test_framework.test_framework import BitcoinTestFramework
15from test_framework.util import (
16    assert_equal,
17    assert_greater_than,
18    sha256sum_file,
19)
20
21
22class ToolWalletTest(BitcoinTestFramework):
23    def set_test_params(self):
24        self.num_nodes = 1
25        self.setup_clean_chain = True
26        self.rpc_timeout = 120
27
28    def skip_test_if_missing_module(self):
29        self.skip_if_no_wallet()
30        self.skip_if_no_wallet_tool()
31
32    def bitcoin_wallet_process(self, *args):
33        default_args = ['-datadir={}'.format(self.nodes[0].datadir_path), '-chain=%s' % self.chain]
34
35        return subprocess.Popen(self.get_binaries().wallet_argv() + default_args + list(args), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
36
37    def assert_raises_tool_error(self, error, *args):
38        p = self.bitcoin_wallet_process(*args)
39        stdout, stderr = p.communicate()
40        assert_equal(stdout, '')
41        if isinstance(error, tuple):
42            assert_equal(p.poll(), error[0])
43            assert error[1] in stderr.strip()
44        else:
45            assert_equal(p.poll(), 1)
46            assert error in stderr.strip()
47
48    def assert_tool_output(self, output, *args):
49        p = self.bitcoin_wallet_process(*args)
50        stdout, stderr = p.communicate()
51        assert_equal(stderr, '')
52        assert_equal(stdout, output)
53        assert_equal(p.poll(), 0)
54
55    def wallet_shasum(self):
56        return sha256sum_file(self.wallet_path).hex()
57
58    def wallet_timestamp(self):
59        return os.path.getmtime(self.wallet_path)
60
61    def wallet_permissions(self):
62        return oct(os.lstat(self.wallet_path).st_mode)[-3:]
63
64    def log_wallet_timestamp_comparison(self, old, new):
65        result = 'unchanged' if new == old else 'increased!'
66        self.log.debug('Wallet file timestamp {}'.format(result))
67
68    def get_expected_info_output(self, name="", transactions=0, keypool=2, address=0, imported_privs=0):
69        wallet_name = self.default_wallet_name if name == "" else name
70        output_types = 4  # p2pkh, p2sh, segwit, bech32m
71        return textwrap.dedent('''\
72            Wallet info
73            ===========
74            Name: %s
75            Format: sqlite
76            Descriptors: yes
77            Encrypted: no
78            HD (hd seed available): yes
79            Keypool Size: %d
80            Transactions: %d
81            Address Book: %d
82        ''' % (wallet_name, keypool * output_types, transactions, imported_privs * 3 + address))
83
84    def read_dump(self, filename):
85        dump = OrderedDict()
86        with open(filename, "r") as f:
87            for row in f:
88                row = row.strip()
89                key, value = row.split(',')
90                dump[key] = value
91        return dump
92
93    def assert_is_sqlite(self, filename):
94        with open(filename, 'rb') as f:
95            file_magic = f.read(16)
96            assert_equal(file_magic, b'SQLite format 3\x00')
97
98    def write_dump(self, dump, filename, magic=None, skip_checksum=False):
99        if magic is None:
100            magic = "BITCOIN_CORE_WALLET_DUMP"
101        with open(filename, "w") as f:
102            row = ",".join([magic, dump[magic]]) + "\n"
103            f.write(row)
104            for k, v in dump.items():
105                if k == magic or k == "checksum":
106                    continue
107                row = ",".join([k, v]) + "\n"
108                f.write(row)
109            if not skip_checksum:
110                row = ",".join(["checksum", dump["checksum"]]) + "\n"
111                f.write(row)
112
113    def do_tool_createfromdump(self, wallet_name, dumpfile):
114        dumppath = self.nodes[0].datadir_path / dumpfile
115        rt_dumppath = self.nodes[0].datadir_path / "rt-{}.dump".format(wallet_name)
116
117        args = ["-wallet={}".format(wallet_name),
118                "-dumpfile={}".format(dumppath)]
119        args.append("createfromdump")
120
121        load_output = ""
122        self.assert_tool_output(load_output, *args)
123        assert (self.nodes[0].wallets_path / wallet_name).is_dir()
124
125        self.assert_tool_output("The dumpfile may contain private keys. To ensure the safety of your Bitcoin, do not share the dumpfile.\n", '-wallet={}'.format(wallet_name), '-dumpfile={}'.format(rt_dumppath), 'dump')
126
127        wallet_dat = self.nodes[0].wallets_path / wallet_name / "wallet.dat"
128        self.assert_is_sqlite(wallet_dat)
129
130    def test_invalid_tool_commands_and_args(self):
131        self.log.info('Testing that various invalid commands raise with specific error messages')
132        self.assert_raises_tool_error("Error parsing command line arguments: Invalid command 'foo'", 'foo')
133        # `bitcoin-wallet help` raises an error. Use `bitcoin-wallet -help`.
134        self.assert_raises_tool_error("Error parsing command line arguments: Invalid command 'help'", 'help')
135        self.assert_raises_tool_error('Error: Additional arguments provided (create). Methods do not take arguments. Please refer to `-help`.', 'info', 'create')
136        self.assert_raises_tool_error('Error parsing command line arguments: Invalid parameter -foo', '-foo')
137        self.assert_raises_tool_error('No method provided. Run `bitcoin-wallet -help` for valid methods.')
138        self.assert_raises_tool_error('Wallet name must be provided when creating a new wallet.', 'create')
139        self.assert_raises_tool_error('Wallet name must be provided when creating a new wallet.', 'createfromdump')
140        error = f"SQLiteDatabase: Unable to obtain an exclusive lock on the database, is it being used by another instance of {self.config['environment']['CLIENT_NAME']}?"
141        self.assert_raises_tool_error(
142            error,
143            '-wallet=' + self.default_wallet_name,
144            'info',
145        )
146        path = self.nodes[0].wallets_path / "nonexistent.dat"
147        self.assert_raises_tool_error("Failed to load database path '{}'. Path does not exist.".format(path), '-wallet=nonexistent.dat', 'info')
148
149    def test_tool_wallet_info(self):
150        # Stop the node to close the wallet to call the info command.
151        self.stop_node(0)
152        self.log.info('Calling wallet tool info, testing output')
153        #
154        # TODO: Wallet tool info should work with wallet file permissions set to
155        # read-only without raising:
156        # "Error loading wallet.dat. Is wallet being used by another process?"
157        # The following lines should be uncommented and the tests still succeed:
158        #
159        # self.log.debug('Setting wallet file permissions to 400 (read-only)')
160        # os.chmod(self.wallet_path, stat.S_IRUSR)
161        # assert self.wallet_permissions() in ['400', '666'] # Sanity check. 666 on Windows.
162        # shasum_before = self.wallet_shasum()
163        timestamp_before = self.wallet_timestamp()
164        self.log.debug('Wallet file timestamp before calling info: {}'.format(timestamp_before))
165        out = self.get_expected_info_output(imported_privs=1)
166        self.assert_tool_output(out, '-wallet=' + self.default_wallet_name, 'info')
167        timestamp_after = self.wallet_timestamp()
168        self.log.debug('Wallet file timestamp after calling info: {}'.format(timestamp_after))
169        self.log_wallet_timestamp_comparison(timestamp_before, timestamp_after)
170        self.log.debug('Setting wallet file permissions back to 600 (read/write)')
171        os.chmod(self.wallet_path, stat.S_IRUSR | stat.S_IWUSR)
172        assert self.wallet_permissions() in ['600', '666']  # Sanity check. 666 on Windows.
173        #
174        # TODO: Wallet tool info should not write to the wallet file.
175        # The following lines should be uncommented and the tests still succeed:
176        #
177        # assert_equal(timestamp_before, timestamp_after)
178        # shasum_after = self.wallet_shasum()
179        # assert_equal(shasum_before, shasum_after)
180        # self.log.debug('Wallet file shasum unchanged\n')
181
182    def test_tool_wallet_info_after_transaction(self):
183        """
184        Mutate the wallet with a transaction to verify that the info command
185        output changes accordingly.
186        """
187        self.start_node(0)
188        self.log.info('Generating transaction to mutate wallet')
189        self.generate(self.nodes[0], 1)
190        self.stop_node(0)
191
192        self.log.info('Calling wallet tool info after generating a transaction, testing output')
193        shasum_before = self.wallet_shasum()
194        timestamp_before = self.wallet_timestamp()
195        self.log.debug('Wallet file timestamp before calling info: {}'.format(timestamp_before))
196        out = self.get_expected_info_output(transactions=1, imported_privs=1)
197        self.assert_tool_output(out, '-wallet=' + self.default_wallet_name, 'info')
198        shasum_after = self.wallet_shasum()
199        timestamp_after = self.wallet_timestamp()
200        self.log.debug('Wallet file timestamp after calling info: {}'.format(timestamp_after))
201        self.log_wallet_timestamp_comparison(timestamp_before, timestamp_after)
202        #
203        # TODO: Wallet tool info should not write to the wallet file.
204        # This assertion should be uncommented and succeed:
205        # assert_equal(timestamp_before, timestamp_after)
206        assert_equal(shasum_before, shasum_after)
207        self.log.debug('Wallet file shasum unchanged\n')
208
209    def test_tool_wallet_create_on_existing_wallet(self):
210        self.log.info('Calling wallet tool create on an existing wallet, testing output')
211        shasum_before = self.wallet_shasum()
212        timestamp_before = self.wallet_timestamp()
213        self.log.debug('Wallet file timestamp before calling create: {}'.format(timestamp_before))
214        out = "Topping up keypool...\n" + self.get_expected_info_output(name="foo", keypool=2000)
215        self.assert_tool_output(out, '-wallet=foo', 'create')
216        shasum_after = self.wallet_shasum()
217        timestamp_after = self.wallet_timestamp()
218        self.log.debug('Wallet file timestamp after calling create: {}'.format(timestamp_after))
219        self.log_wallet_timestamp_comparison(timestamp_before, timestamp_after)
220        assert_equal(timestamp_before, timestamp_after)
221        assert_equal(shasum_before, shasum_after)
222        self.log.debug('Wallet file shasum unchanged\n')
223
224    def test_getwalletinfo_on_different_wallet(self):
225        self.log.info('Starting node with arg -wallet=foo')
226        self.start_node(0, ['-nowallet', '-wallet=foo'])
227
228        self.log.info('Calling getwalletinfo on a different wallet ("foo"), testing output')
229        shasum_before = self.wallet_shasum()
230        timestamp_before = self.wallet_timestamp()
231        self.log.debug('Wallet file timestamp before calling getwalletinfo: {}'.format(timestamp_before))
232        out = self.nodes[0].getwalletinfo()
233        self.stop_node(0)
234
235        shasum_after = self.wallet_shasum()
236        timestamp_after = self.wallet_timestamp()
237        self.log.debug('Wallet file timestamp after calling getwalletinfo: {}'.format(timestamp_after))
238
239        assert_equal(0, out['txcount'])
240        assert_equal(4000, out['keypoolsize'])
241        assert_equal(4000, out['keypoolsize_hd_internal'])
242
243        self.log_wallet_timestamp_comparison(timestamp_before, timestamp_after)
244        assert_equal(timestamp_before, timestamp_after)
245        assert_equal(shasum_after, shasum_before)
246        self.log.debug('Wallet file shasum unchanged\n')
247
248    def test_dump_createfromdump(self):
249        self.start_node(0)
250        self.nodes[0].createwallet("todump")

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.