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,809 bytes · SHA-256 07a979bf066a52bd… · 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 wallet keypool and interaction with wallet encryption/locking."""
6
7from decimal import Decimal
8
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.descriptors import descsum_create
11from test_framework.extendedkey import ExtendedPrivateKey
12from test_framework.util import (
13    assert_equal,
14    assert_not_equal,
15    assert_raises_rpc_error,
16)
17from test_framework.wallet_util import WalletUnlock
18
19class KeyPoolTest(BitcoinTestFramework):
20    def set_test_params(self):
21        self.num_nodes = 1
22
23    def skip_test_if_missing_module(self):
24        self.skip_if_no_wallet()
25
26    def run_test(self):
27        nodes = self.nodes
28        addr_before_encrypting = nodes[0].getnewaddress()
29        addr_before_encrypting_data = nodes[0].getaddressinfo(addr_before_encrypting)
30
31        # Encrypt wallet and wait to terminate
32        nodes[0].encryptwallet('test')
33        # Import hardened derivation only descriptors
34        nodes[0].walletpassphrase('test', 10)
35        nodes[0].importdescriptors([
36            {
37                "desc": descsum_create(f"wpkh({ExtendedPrivateKey.generate().to_string()}/0h/*h)"),
38                "timestamp": "now",
39                "range": [0,0],
40                "active": True
41            },
42            {
43                "desc": descsum_create(f"pkh({ExtendedPrivateKey.generate().to_string()}/1h/*h)"),
44                "timestamp": "now",
45                "range": [0,0],
46                "active": True
47            },
48            {
49                "desc": descsum_create(f"sh(wpkh({ExtendedPrivateKey.generate().to_string()}/2h/*h))"),
50                "timestamp": "now",
51                "range": [0,0],
52                "active": True
53            },
54            {
55                "desc": descsum_create(f"wpkh({ExtendedPrivateKey.generate().to_string()}/3h/*h)"),
56                "timestamp": "now",
57                "range": [0,0],
58                "active": True,
59                "internal": True
60            },
61            {
62                "desc": descsum_create(f"pkh({ExtendedPrivateKey.generate().to_string()}/4h/*h)"),
63                "timestamp": "now",
64                "range": [0,0],
65                "active": True,
66                "internal": True
67            },
68            {
69                "desc": descsum_create(f"sh(wpkh({ExtendedPrivateKey.generate().to_string()}/5h/*h))"),
70                "timestamp": "now",
71                "range": [0,0],
72                "active": True,
73                "internal": True
74            }
75        ])
76        nodes[0].walletlock()
77        # Keep creating keys
78        addr = nodes[0].getnewaddress()
79        addr_data = nodes[0].getaddressinfo(addr)
80        assert_not_equal(addr_before_encrypting_data['hdmasterfingerprint'], addr_data['hdmasterfingerprint'])
81        assert_raises_rpc_error(-12, "Error: Keypool ran out, please call keypoolrefill first", nodes[0].getnewaddress)
82
83        # put six (plus 2) new keys in the keypool (100% external-, +100% internal-keys, 1 in min)
84        with WalletUnlock(nodes[0], 'test'):
85            nodes[0].keypoolrefill(6)
86        wi = nodes[0].getwalletinfo()
87        assert_equal(wi['keypoolsize_hd_internal'], 24)
88        assert_equal(wi['keypoolsize'], 24)
89
90        # drain the internal keys
91        nodes[0].getrawchangeaddress()
92        nodes[0].getrawchangeaddress()
93        nodes[0].getrawchangeaddress()
94        nodes[0].getrawchangeaddress()
95        nodes[0].getrawchangeaddress()
96        nodes[0].getrawchangeaddress()
97        # remember keypool sizes
98        wi = nodes[0].getwalletinfo()
99        kp_size_before = [wi['keypoolsize_hd_internal'], wi['keypoolsize']]
100        # the next one should fail
101        assert_raises_rpc_error(-12, "Keypool ran out", nodes[0].getrawchangeaddress)
102        # check that keypool sizes did not change
103        wi = nodes[0].getwalletinfo()
104        kp_size_after = [wi['keypoolsize_hd_internal'], wi['keypoolsize']]
105        assert_equal(kp_size_before, kp_size_after)
106
107        # drain the external keys
108        addr = set()
109        addr.add(nodes[0].getnewaddress(address_type="bech32"))
110        addr.add(nodes[0].getnewaddress(address_type="bech32"))
111        addr.add(nodes[0].getnewaddress(address_type="bech32"))
112        addr.add(nodes[0].getnewaddress(address_type="bech32"))
113        addr.add(nodes[0].getnewaddress(address_type="bech32"))
114        addr.add(nodes[0].getnewaddress(address_type="bech32"))
115        assert_equal(len(addr), 6)
116        # remember keypool sizes
117        wi = nodes[0].getwalletinfo()
118        kp_size_before = [wi['keypoolsize_hd_internal'], wi['keypoolsize']]
119        # the next one should fail
120        assert_raises_rpc_error(-12, "Error: Keypool ran out, please call keypoolrefill first", nodes[0].getnewaddress)
121        # check that keypool sizes did not change
122        wi = nodes[0].getwalletinfo()
123        kp_size_after = [wi['keypoolsize_hd_internal'], wi['keypoolsize']]
124        assert_equal(kp_size_before, kp_size_after)
125
126        # refill keypool with three new addresses
127        nodes[0].walletpassphrase('test', 1)
128        nodes[0].keypoolrefill(3)
129
130        # test walletpassphrase timeout
131        # CScheduler relies on condition_variable::wait_until() which does not
132        # guarantee accurate timing. We'll wait up to 5 seconds to execute a 1
133        # second scheduled event.
134        nodes[0].wait_until(lambda: nodes[0].getwalletinfo()["unlocked_until"] == 0, timeout=5)
135
136        # drain the keypool
137        for _ in range(3):
138            nodes[0].getnewaddress()
139        assert_raises_rpc_error(-12, "Keypool ran out", nodes[0].getnewaddress)
140
141        with WalletUnlock(nodes[0], 'test'):
142            nodes[0].keypoolrefill(100)
143            wi = nodes[0].getwalletinfo()
144            assert_equal(wi['keypoolsize_hd_internal'], 400)
145            assert_equal(wi['keypoolsize'], 400)
146
147        # create a blank wallet
148        nodes[0].createwallet(wallet_name='w2', blank=True, disable_private_keys=True)
149        w2 = nodes[0].get_wallet_rpc('w2')
150
151        # refer to initial wallet as w1
152        w1 = nodes[0].get_wallet_rpc(self.default_wallet_name)
153
154        # import private key and fund it
155        address = addr.pop()
156        desc = w1.getaddressinfo(address)['desc']
157        res = w2.importdescriptors([{'desc': desc, 'timestamp': 'now'}])
158        assert_equal(res[0]['success'], True)
159
160        with WalletUnlock(w1, 'test'):
161            res = w1.sendtoaddress(address=address, amount=0.00010000)
162        self.generate(nodes[0], 1)
163        destination = addr.pop()
164
165        # Using a fee rate (10 sat / byte) well above the minimum relay rate
166        # creating a 5,000 sat transaction with change should not be possible
167        assert_raises_rpc_error(-4, "Transaction needs a change address, but we can't generate it.", w2.walletcreatefundedpsbt, inputs=[], outputs=[{addr.pop(): 0.00005000}], subtractFeeFromOutputs=[0], feeRate=0.00010)
168
169        # creating a 10,000 sat transaction without change, with a manual input, should still be possible
170        res = w2.walletcreatefundedpsbt(inputs=w2.listunspent(), outputs=[{destination: 0.00010000}], subtractFeeFromOutputs=[0], feeRate=0.00010)
171        assert_equal("psbt" in res, True)
172
173        # creating a 10,000 sat transaction without change should still be possible
174        res = w2.walletcreatefundedpsbt(inputs=[], outputs=[{destination: 0.00010000}], subtractFeeFromOutputs=[0], feeRate=0.00010)
175        assert_equal("psbt" in res, True)
176        # should work without subtractFeeFromOutputs if the exact fee is subtracted from the amount
177        res = w2.walletcreatefundedpsbt(inputs=[], outputs=[{destination: 0.00008900}], feeRate=0.00010)
178        assert_equal("psbt" in res, True)
179
180        # dust change should be removed
181        res = w2.walletcreatefundedpsbt(inputs=[], outputs=[{destination: 0.00008800}], feeRate=0.00010)
182        assert_equal("psbt" in res, True)
183
184        # create a transaction without change at the maximum fee rate, such that the output is still spendable:
185        res = w2.walletcreatefundedpsbt(inputs=[], outputs=[{destination: 0.00010000}], subtractFeeFromOutputs=[0], feeRate=0.0008823)
186        assert_equal("psbt" in res, True)
187        assert_equal(res["fee"], Decimal("0.00009706"))
188
189        # creating a 10,000 sat transaction with a manual change address should be possible
190        res = w2.walletcreatefundedpsbt(inputs=[], outputs=[{destination: 0.00010000}], subtractFeeFromOutputs=[0], feeRate=0.00010, changeAddress=addr.pop())
191        assert_equal("psbt" in res, True)
192
193if __name__ == '__main__':
194    KeyPoolTest(__file__).main()
195

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.