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.

11,849 bytes · SHA-256 012385ba5c81b40a… · 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 createwallet arguments.
6"""
7import os
8import stat
9
10from test_framework.descriptors import descsum_create
11from test_framework.extendedkey import ExtendedPrivateKey
12from test_framework.test_framework import BitcoinTestFramework
13from test_framework.util import (
14    assert_equal,
15    assert_raises_rpc_error,
16    is_dir_writable,
17    wallet_importprivkey,
18)
19from test_framework.wallet_util import generate_keypair, WalletUnlock
20
21
22EMPTY_PASSPHRASE_MSG = "Empty string given as passphrase, wallet will not be encrypted."
23
24
25class CreateWalletTest(BitcoinTestFramework):
26    def set_test_params(self):
27        self.num_nodes = 1
28
29    def skip_test_if_missing_module(self):
30        self.skip_if_no_wallet()
31
32    def test_bad_dir_permissions(self, node):
33        self.log.info("Test wallet creation failure due to non-writable directory")
34        wallet_name = "bad_permissions"
35        dir_path = node.wallets_path / wallet_name
36        dir_path.mkdir(parents=True)
37        original_dir_perms = dir_path.stat().st_mode
38        os.chmod(dir_path, original_dir_perms & ~(stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH))
39        if is_dir_writable(dir_path):
40            self.log.warning("Skipping non-writable directory test: unable to enforce read-only permissions")
41        else:
42            # Run actual test
43            assert_raises_rpc_error(-4, f"SQLiteDatabase: Failed to open database in directory '{str(dir_path)}': directory is not writable", node.createwallet, wallet_name=wallet_name)
44        # Reset directory permissions for cleanup
45        dir_path.chmod(original_dir_perms)
46
47
48    def run_test(self):
49        node = self.nodes[0]
50
51        self.test_bad_dir_permissions(node)
52
53        self.log.info("Run createwallet with invalid parameters.")
54        # Run createwallet with invalid parameters. This must not prevent a new wallet with the same name from being created with the correct parameters.
55        assert_raises_rpc_error(-4, "Passphrase provided but private keys are disabled. A passphrase is only used to encrypt private keys, so cannot be used for wallets with private keys disabled.",
56            self.nodes[0].createwallet, wallet_name='w0', disable_private_keys=True, passphrase="passphrase")
57        assert_raises_rpc_error(-8, "Wallet name cannot be empty", self.nodes[0].createwallet, "")
58
59        self.nodes[0].createwallet(wallet_name='w0')
60        w0 = node.get_wallet_rpc('w0')
61        address1 = w0.getnewaddress()
62
63        self.log.info("Test disableprivatekeys creation.")
64        self.nodes[0].createwallet(wallet_name='w1', disable_private_keys=True)
65        w1 = node.get_wallet_rpc('w1')
66        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w1.getnewaddress)
67        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w1.getrawchangeaddress)
68        import_res = w1.importdescriptors([{"desc": w0.getaddressinfo(address1)['desc'], "timestamp": "now"}])
69        assert_equal(import_res[0]["success"], True)
70        assert_equal(sorted(w1.getwalletinfo()["flags"]), sorted(["last_hardened_xpub_cached", "descriptor_wallet", "disable_private_keys"]))
71
72        self.log.info('Test that private keys cannot be imported')
73        privkey, pubkey = generate_keypair(wif=True)
74        result = w1.importdescriptors([{'desc': descsum_create('wpkh(' + privkey + ')'), 'timestamp': 'now'}])
75        assert not result[0]['success']
76        assert 'warnings' not in result[0]
77        assert_equal(result[0]['error']['code'], -4)
78        assert_equal(result[0]['error']['message'], 'Cannot import private keys to a wallet with private keys disabled')
79
80        self.log.info("Test blank creation with private keys disabled.")
81        self.nodes[0].createwallet(wallet_name='w2', disable_private_keys=True, blank=True)
82        w2 = node.get_wallet_rpc('w2')
83        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w2.getnewaddress)
84        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w2.getrawchangeaddress)
85        import_res = w2.importdescriptors([{"desc": w0.getaddressinfo(address1)['desc'], "timestamp": "now"}])
86        assert_equal(import_res[0]["success"], True)
87
88        self.log.info("Test blank creation with private keys enabled.")
89        self.nodes[0].createwallet(wallet_name='w3', disable_private_keys=False, blank=True)
90        w3 = node.get_wallet_rpc('w3')
91        assert_equal(w3.getwalletinfo()['keypoolsize'], 0)
92        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w3.getnewaddress)
93        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w3.getrawchangeaddress)
94        # Import private key
95        wallet_importprivkey(w3, generate_keypair(wif=True)[0], "now")
96        # Imported private keys are currently ignored by the keypool
97        assert_equal(w3.getwalletinfo()['keypoolsize'], 0)
98        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w3.getnewaddress)
99        # Set the seed
100        w3.importdescriptors([{
101            'desc': descsum_create(f'wpkh({ExtendedPrivateKey.generate().to_string()}/0h/*)'),
102            'timestamp': 'now',
103            'active': True
104        },
105        {
106            'desc': descsum_create(f'wpkh({ExtendedPrivateKey.generate().to_string()}/1h/*)'),
107            'timestamp': 'now',
108            'active': True,
109            'internal': True
110        }])
111        assert_equal(w3.getwalletinfo()['keypoolsize'], 1)
112        w3.getnewaddress()
113        w3.getrawchangeaddress()
114
115        self.log.info("Test blank creation with privkeys enabled and then encryption")
116        self.nodes[0].createwallet(wallet_name='w4', disable_private_keys=False, blank=True)
117        w4 = node.get_wallet_rpc('w4')
118        assert_equal(w4.getwalletinfo()['keypoolsize'], 0)
119        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w4.getnewaddress)
120        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w4.getrawchangeaddress)
121        # Encrypt the wallet. Nothing should change about the keypool
122        w4.encryptwallet('pass')
123        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w4.getnewaddress)
124        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w4.getrawchangeaddress)
125        with WalletUnlock(w4, "pass"):
126            # Now set a seed and it should work. Wallet should also be encrypted
127            w4.importdescriptors([{
128                'desc': descsum_create(f'wpkh({ExtendedPrivateKey.generate().to_string()}/0h/*)'),
129                'timestamp': 'now',
130                'active': True
131            },
132            {
133                'desc': descsum_create(f'wpkh({ExtendedPrivateKey.generate().to_string()}/1h/*)'),
134                'timestamp': 'now',
135                'active': True,
136                'internal': True
137            }])
138            w4.getnewaddress()
139            w4.getrawchangeaddress()
140
141        self.log.info("Test blank creation with privkeys disabled and then encryption")
142        self.nodes[0].createwallet(wallet_name='w5', disable_private_keys=True, blank=True)
143        w5 = node.get_wallet_rpc('w5')
144        assert_equal(w5.getwalletinfo()['keypoolsize'], 0)
145        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w5.getnewaddress)
146        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w5.getrawchangeaddress)
147        # Encrypt the wallet
148        assert_raises_rpc_error(-16, "Error: wallet does not contain private keys, nothing to encrypt.", w5.encryptwallet, 'pass')
149        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w5.getnewaddress)
150        assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w5.getrawchangeaddress)
151
152        self.log.info('New blank and encrypted wallets can be created')
153        self.nodes[0].createwallet(wallet_name='wblank', disable_private_keys=False, blank=True, passphrase='thisisapassphrase')
154        wblank = node.get_wallet_rpc('wblank')
155        assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first.", wblank.signmessage, "needanargument", "test")
156        with WalletUnlock(wblank, "thisisapassphrase"):
157            assert_raises_rpc_error(-4, "Error: This wallet has no available keys", wblank.getnewaddress)
158            assert_raises_rpc_error(-4, "Error: This wallet has no available keys", wblank.getrawchangeaddress)
159
160        self.log.info('Test creating a new encrypted wallet.')
161        # Born encrypted wallet is created (has keys)
162        self.nodes[0].createwallet(wallet_name='w6', disable_private_keys=False, blank=False, passphrase='thisisapassphrase')
163        w6 = node.get_wallet_rpc('w6')
164        assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first.", w6.signmessage, "needanargument", "test")
165        with WalletUnlock(w6, "thisisapassphrase"):
166            w6.signmessage(w6.getnewaddress('', 'legacy'), "test")
167            w6.keypoolrefill(1)
168            # There should only be 1 key for legacy, 3 for descriptors
169            walletinfo = w6.getwalletinfo()
170            keys = 4
171            assert_equal(walletinfo['keypoolsize'], keys)
172            assert_equal(walletinfo['keypoolsize_hd_internal'], keys)
173        # Allow empty passphrase, but there should be a warning
174        resp = self.nodes[0].createwallet(wallet_name='w7', disable_private_keys=False, blank=False, passphrase='')
175        assert_equal(resp["warnings"], [EMPTY_PASSPHRASE_MSG])
176
177        w7 = node.get_wallet_rpc('w7')
178        assert_raises_rpc_error(-15, 'Error: running with an unencrypted wallet, but walletpassphrase was called.', w7.walletpassphrase, '', 60)
179
180        self.log.info('Test making a wallet with avoid reuse flag')
181        self.nodes[0].createwallet('w8', False, False, '', True) # Use positional arguments to check for bug where avoid_reuse could not be set for wallets without needing them to be encrypted
182        w8 = node.get_wallet_rpc('w8')
183        assert_raises_rpc_error(-15, 'Error: running with an unencrypted wallet, but walletpassphrase was called.', w7.walletpassphrase, '', 60)
184        assert_equal(w8.getwalletinfo()["avoid_reuse"], True)
185
186        self.log.info('Using a passphrase with private keys disabled returns error')
187        assert_raises_rpc_error(-4, 'Passphrase provided but private keys are disabled. A passphrase is only used to encrypt private keys, so cannot be used for wallets with private keys disabled.', self.nodes[0].createwallet, wallet_name='w9', disable_private_keys=True, passphrase='thisisapassphrase')
188
189        self.log.info("Test that legacy wallets cannot be created")
190        assert_raises_rpc_error(-4, 'descriptors argument must be set to "true"; it is no longer possible to create a legacy wallet.', self.nodes[0].createwallet, wallet_name="legacy", descriptors=False)
191
192        self.log.info("Check that the version number is being logged correctly")
193
194        # Craft the expected version message.
195        client_version = node.getnetworkinfo()["version"]
196        version_message = f"Last client version = {client_version}"
197
198        # Should not be logged when creating.
199        with node.assert_debug_log(expected_msgs=[], unexpected_msgs=[version_message]):
200            node.createwallet("version_check")
201            node.unloadwallet("version_check")
202        # Should be logged when loading.
203        with node.assert_debug_log(expected_msgs=[version_message]):
204            node.loadwallet("version_check")
205
206
207if __name__ == '__main__':
208    CreateWalletTest(__file__).main()
209

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.