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,688 bytes · SHA-256 4e96d5f7e1f6384a… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2017-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 multiwallet.
6
7Verify that a bitcoind node can load multiple wallet files
8"""
9from threading import Thread
10import os
11import platform
12import shutil
13import stat
14
15from test_framework.blocktools import COINBASE_MATURITY
16from test_framework.test_framework import BitcoinTestFramework
17from test_framework.test_node import ErrorMatch
18from test_framework.util import (
19    assert_equal,
20    assert_raises_rpc_error,
21    ensure_for,
22    JSONRPCException,
23)
24
25got_loading_error = False
26
27
28def test_load_unload(node, name):
29    global got_loading_error
30    while True:
31        if got_loading_error:
32            return
33        try:
34            node.loadwallet(name)
35            node.unloadwallet(name)
36        except JSONRPCException as e:
37            if e.error['code'] == -4 and 'Wallet already loading' in e.error['message']:
38                got_loading_error = True
39                return
40
41def data_dir(node, *p):
42    return os.path.join(node.chain_path, *p)
43
44def wallet_dir(node, *p):
45    return data_dir(node, 'wallets', *p)
46
47def get_wallet(node, name):
48    return node.get_wallet_rpc(name)
49
50
51class MultiWalletTest(BitcoinTestFramework):
52    def set_test_params(self):
53        self.setup_clean_chain = True
54        self.num_nodes = 2
55        self.rpc_timeout = 120
56        self.extra_args = [["-nowallet"], []]
57
58    def skip_test_if_missing_module(self):
59        self.skip_if_no_wallet()
60
61    def wallet_file(self, node, name):
62        if name == self.default_wallet_name:
63            return wallet_dir(node, self.default_wallet_name, self.wallet_data_filename)
64        if os.path.isdir(wallet_dir(node, name)):
65            return wallet_dir(node, name, "wallet.dat")
66        return wallet_dir(node, name)
67
68    def run_test(self):
69        self.check_chmod = True
70        self.check_symlinks = True
71        if platform.system() == 'Windows':
72            # Additional context:
73            # - chmod: Posix has one user per file while Windows has an ACL approach
74            # - symlinks: GCC 13 has FIXME notes for symlinks under Windows:
75            #   https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=libstdc%2B%2B-v3/src/filesystem/ops-common.h;h=ba377905a2e90f7baf30c900b090f1f732397e08;hb=refs/heads/releases/gcc-13#l124
76            self.log.warning('Skipping chmod+symlink checks on Windows: '
77                             'chmod works differently due to how access rights work and '
78                             'symlink behavior with regard to the standard library is non-standard on cross-built binaries.')
79            self.check_chmod = False
80            self.check_symlinks = False
81        elif os.geteuid() == 0:
82            self.log.warning('Skipping checks involving chmod as they require non-root permissions.')
83            self.check_chmod = False
84
85        node = self.nodes[0]
86
87        assert_equal(node.listwalletdir(), {'wallets': [{'name': self.default_wallet_name, "warnings": []}]})
88
89        self.test_invalid_wallet_names()
90
91        # check wallet.dat is created
92        self.stop_nodes()
93        assert_equal(os.path.isfile(wallet_dir(node, self.default_wallet_name, self.wallet_data_filename)), True)
94
95        self.test_scanning_main_dir_access(node)
96        empty_wallet, empty_created_wallet, wallet_names, in_wallet_dir = self.test_mixed_wallets(node)
97        self.test_scanning_sub_dir(node, in_wallet_dir)
98        self.test_scanning_symlink_levels(node, in_wallet_dir)
99        self.test_init(node, wallet_names)
100        self.test_balances_and_fees(node, wallet_names, in_wallet_dir)
101        w1, w2 = self.test_loading(node, wallet_names)
102        self.test_creation(node, in_wallet_dir)
103        self.test_unloading(node, in_wallet_dir, w1, w2)
104        self.test_backup_and_restore(node, wallet_names, empty_wallet, empty_created_wallet)
105        self.test_lock_file_closed(node)
106
107    def test_scanning_main_dir_access(self, node):
108        if not self.check_chmod:
109            return
110
111        self.log.info("Verify warning is emitted when failing to scan the wallets directory")
112        self.start_node(0)
113        with node.assert_debug_log(unexpected_msgs=['Error scanning directory entries under'], expected_msgs=[]):
114            result = node.listwalletdir()
115            assert_equal(result, {'wallets': [{'name': 'default_wallet', 'warnings': []}]})
116        os.chmod(data_dir(node, 'wallets'), 0)
117        with node.assert_debug_log(expected_msgs=['Error scanning directory entries under']):
118            result = node.listwalletdir()
119            assert_equal(result, {'wallets': []})
120        self.stop_node(0)
121        # Restore permissions
122        os.chmod(data_dir(node, 'wallets'), stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
123
124    def test_mixed_wallets(self, node):
125        self.log.info("Test mixed wallets")
126        # create symlink to verify wallet directory path can be referenced
127        # through symlink
128        os.mkdir(wallet_dir(node, 'w7'))
129        os.symlink('w7', wallet_dir(node, 'w7_symlink'))
130
131        if self.check_symlinks:
132            os.symlink('..', wallet_dir(node, 'recursive_dir_symlink'))
133
134        # rename wallet.dat to make sure plain wallet file paths (as opposed to
135        # directory paths) can be loaded
136        # create another dummy wallet for use in testing backups later
137        self.start_node(0)
138        node.createwallet("empty")
139        node.createwallet("plain")
140        node.createwallet("created")
141        self.stop_nodes()
142        empty_wallet = os.path.join(self.options.tmpdir, 'empty.dat')
143        os.rename(self.wallet_file(node, "empty"), empty_wallet)
144        os.rmdir(wallet_dir(node, "empty"))
145        empty_created_wallet = os.path.join(self.options.tmpdir, 'empty.created.dat')
146        os.rename(wallet_dir(node, "created", self.wallet_data_filename), empty_created_wallet)
147        os.rmdir(wallet_dir(node, "created"))
148        os.rename(self.wallet_file(node, "plain"), wallet_dir(node, "w8"))
149        os.rmdir(wallet_dir(node, "plain"))
150
151        # restart node with a mix of wallet names:
152        #   w1, w2, w3 - to verify new wallets created when non-existing paths specified
153        #   w          - to verify wallet name matching works when one wallet path is prefix of another
154        #   sub/w5     - to verify relative wallet path is created correctly
155        #   extern/w6  - to verify absolute wallet path is created correctly
156        #   w7_symlink - to verify symlinked wallet path is initialized correctly
157        #   w8         - to verify existing wallet file is loaded correctly. Not tested for SQLite wallets as this is a deprecated BDB behavior.
158        #   ''         - to verify default wallet file is created correctly
159        to_create = ['w1', 'w2', 'w3', 'w', 'sub/w5', 'w7_symlink']
160        in_wallet_dir = [w.replace('/', os.path.sep) for w in to_create]  # Wallets in the wallet dir
161        in_wallet_dir.append('w7')  # w7 is not loaded or created, but will be listed by listwalletdir because w7_symlink
162        to_create.append(os.path.join(self.options.tmpdir, 'extern/w6'))  # External, not in the wallet dir, so we need to avoid adding it to in_wallet_dir
163        to_load = [self.default_wallet_name]
164        wallet_names = to_create + to_load  # Wallet names loaded in the wallet
165        in_wallet_dir += to_load  # The loaded wallets are also in the wallet dir
166        self.start_node(0)
167        for wallet_name in to_create:
168            node.createwallet(wallet_name)
169        for wallet_name in to_load:
170            node.loadwallet(wallet_name)
171
172        return empty_wallet, empty_created_wallet, wallet_names, in_wallet_dir
173
174    def test_scanning_sub_dir(self, node, in_wallet_dir):
175        if not self.check_chmod:
176            return
177
178        self.log.info("Test scanning for sub directories")
179        # Baseline, no errors.
180        with node.assert_debug_log(expected_msgs=[], unexpected_msgs=["Error while scanning wallet dir"]):
181            walletlist = node.listwalletdir()['wallets']
182        assert_equal(sorted(map(lambda w: w['name'], walletlist)), sorted(in_wallet_dir))
183
184        # "Permission denied" error.
185        os.mkdir(wallet_dir(node, 'no_access'))
186        os.chmod(wallet_dir(node, 'no_access'), 0)
187        with node.assert_debug_log(expected_msgs=["Error while scanning wallet dir"]):
188            walletlist = node.listwalletdir()['wallets']
189        # Need to ensure access is restored for cleanup
190        os.chmod(wallet_dir(node, 'no_access'), stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
191
192        # Verify that we no longer emit errors after restoring permissions
193        with node.assert_debug_log(expected_msgs=[], unexpected_msgs=["Error while scanning wallet dir"]):
194            walletlist = node.listwalletdir()['wallets']
195        assert_equal(sorted(map(lambda w: w['name'], walletlist)), sorted(in_wallet_dir))
196
197    def test_scanning_symlink_levels(self, node, in_wallet_dir):
198        if not self.check_symlinks:
199            return
200
201        self.log.info("Test for errors from too many levels of symbolic links")
202        os.mkdir(wallet_dir(node, 'self_walletdat_symlink'))
203        os.symlink('wallet.dat', wallet_dir(node, 'self_walletdat_symlink/wallet.dat'))
204        with node.assert_debug_log(expected_msgs=["Error while scanning wallet dir"]):
205            walletlist = node.listwalletdir()['wallets']
206        assert_equal(sorted(map(lambda w: w['name'], walletlist)), sorted(in_wallet_dir))
207
208    def test_init(self, node, wallet_names):
209        self.log.info("Test initialization")
210        assert_equal(set(node.listwallets()), set(wallet_names))
211        # check that all requested wallets were created
212        self.stop_node(0)
213        for wallet_name in wallet_names:
214            assert_equal(os.path.isfile(self.wallet_file(node, wallet_name)), True)
215
216        node.assert_start_raises_init_error(['-walletdir=wallets'], 'Error: Specified -walletdir "wallets" does not exist')
217        node.assert_start_raises_init_error(['-walletdir=wallets'], 'Error: Specified -walletdir "wallets" is a relative path', cwd=data_dir(node))
218        node.assert_start_raises_init_error(['-walletdir=debug.log'], 'Error: Specified -walletdir "debug.log" is not a directory', cwd=data_dir(node))
219
220        self.start_node(0, ['-wallet=w1', '-wallet=w1'])
221        self.stop_node(0, 'Warning: Ignoring duplicate -wallet w1.')
222
223        # should not initialize if wallet file is a symlink
224        if self.check_symlinks:
225            os.symlink('w8', wallet_dir(node, 'w8_symlink'))
226            node.assert_start_raises_init_error(['-wallet=w8_symlink'], r'Error: Invalid -wallet path \'w8_symlink\'\. .*', match=ErrorMatch.FULL_REGEX)
227
228        # should not initialize if the specified walletdir does not exist
229        node.assert_start_raises_init_error(['-walletdir=bad'], 'Error: Specified -walletdir "bad" does not exist')
230        # should not initialize if the specified walletdir is not a directory
231        not_a_dir = wallet_dir(node, 'notadir')
232        open(not_a_dir, 'a').close()
233        node.assert_start_raises_init_error(['-walletdir=' + not_a_dir], 'Error: Specified -walletdir "' + not_a_dir + '" is not a directory')
234
235        # if wallets/ doesn't exist, datadir should be the default wallet dir
236        wallet_dir2 = data_dir(node, 'walletdir')
237        os.rename(wallet_dir(node), wallet_dir2)
238        self.start_node(0)
239        node.createwallet("w4")
240        node.createwallet("w5")
241        assert_equal(set(node.listwallets()), {"w4", "w5"})
242        w5 = get_wallet(node, "w5")
243        self.generatetoaddress(node, nblocks=1, address=w5.getnewaddress(), sync_fun=self.no_op)
244
245        # now if wallets/ exists again, but the rootdir is specified as the walletdir, w4 and w5 should still be loaded
246        os.rename(wallet_dir2, wallet_dir(node))
247        self.restart_node(0, ['-nowallet', '-walletdir=' + data_dir(node)])
248        node.loadwallet("w4")
249        node.loadwallet("w5")
250        assert_equal(set(node.listwallets()), {"w4", "w5"})

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.