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.

15,230 bytes · SHA-256 d0239ebf54dba0b9… · 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 the avoid_reuse and setwalletflag features."""
6
7from test_framework.test_framework import BitcoinTestFramework
8from test_framework.util import (
9    assert_not_equal,
10    assert_approx,
11    assert_equal,
12    assert_raises_rpc_error,
13)
14
15def reset_balance(node, discardaddr):
16    '''Throw away all owned coins by the node so it gets a balance of 0.'''
17    balance = node.getbalance(avoid_reuse=False)
18    if balance > 0.5:
19        node.sendtoaddress(address=discardaddr, amount=balance, subtractfeefromamount=True, avoid_reuse=False)
20
21def count_unspent(node):
22    '''Count the unspent outputs for the given node and return various statistics'''
23    r = {
24        "total": {
25            "count": 0,
26            "sum": 0,
27        },
28        "reused": {
29            "count": 0,
30            "sum": 0,
31        },
32    }
33    supports_reused = True
34    for utxo in node.listunspent(minconf=0):
35        r["total"]["count"] += 1
36        r["total"]["sum"] += utxo["amount"]
37        if supports_reused and "reused" in utxo:
38            if utxo["reused"]:
39                r["reused"]["count"] += 1
40                r["reused"]["sum"] += utxo["amount"]
41        else:
42            supports_reused = False
43    r["reused"]["supported"] = supports_reused
44    return r
45
46def assert_unspent(node, total_count=None, total_sum=None, reused_supported=None, reused_count=None, reused_sum=None, margin=0.001):
47    '''Make assertions about a node's unspent output statistics'''
48    stats = count_unspent(node)
49    if total_count is not None:
50        assert_equal(stats["total"]["count"], total_count)
51    if total_sum is not None:
52        assert_approx(stats["total"]["sum"], total_sum, margin)
53    if reused_supported is not None:
54        assert_equal(stats["reused"]["supported"], reused_supported)
55    if reused_count is not None:
56        assert_equal(stats["reused"]["count"], reused_count)
57    if reused_sum is not None:
58        assert_approx(stats["reused"]["sum"], reused_sum, margin)
59
60def assert_balances(node, mine, margin=0.001):
61    '''Make assertions about a node's getbalances output'''
62    got = node.getbalances()["mine"]
63    for k,v in mine.items():
64        assert_approx(got[k], v, margin)
65
66class AvoidReuseTest(BitcoinTestFramework):
67    def set_test_params(self):
68        self.num_nodes = 2
69        # whitelist peers to speed up tx relay / mempool sync
70        self.noban_tx_relay = True
71
72    def skip_test_if_missing_module(self):
73        self.skip_if_no_wallet()
74
75    def run_test(self):
76        '''Set up initial chain and run tests defined below'''
77
78        self.test_persistence()
79        self.test_immutable()
80
81        self.generate(self.nodes[0], 110)
82        self.test_change_remains_change(self.nodes[1])
83        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
84        self.test_sending_from_reused_address_without_avoid_reuse()
85        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
86        self.test_sending_from_reused_address_fails("legacy")
87        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
88        self.test_sending_from_reused_address_fails("p2sh-segwit")
89        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
90        self.test_sending_from_reused_address_fails("bech32")
91        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
92        self.test_getbalances_used()
93        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
94        self.test_full_destination_group_is_preferred()
95        reset_balance(self.nodes[1], self.nodes[0].getnewaddress())
96        self.test_all_destination_groups_are_used()
97
98    def test_persistence(self):
99        '''Test that wallet files persist the avoid_reuse flag.'''
100        self.log.info("Test wallet files persist avoid_reuse flag")
101
102        # Configure node 1 to use avoid_reuse
103        self.nodes[1].setwalletflag('avoid_reuse')
104
105        # Flags should be node1.avoid_reuse=false, node2.avoid_reuse=true
106        assert_equal(self.nodes[0].getwalletinfo()["avoid_reuse"], False)
107        assert_equal(sorted(self.nodes[0].getwalletinfo()["flags"]), sorted(["descriptor_wallet", "last_hardened_xpub_cached"]))
108        assert_equal(self.nodes[1].getwalletinfo()["avoid_reuse"], True)
109        assert_equal(sorted(self.nodes[1].getwalletinfo()["flags"]), sorted(["descriptor_wallet", "last_hardened_xpub_cached", "avoid_reuse"]))
110
111        self.restart_node(1)
112        self.connect_nodes(0, 1)
113
114        # Flags should still be node1.avoid_reuse=false, node2.avoid_reuse=true
115        assert_equal(self.nodes[0].getwalletinfo()["avoid_reuse"], False)
116        assert_equal(self.nodes[1].getwalletinfo()["avoid_reuse"], True)
117
118        # Attempting to set flag to its current state should throw
119        assert_raises_rpc_error(-8, "Wallet flag is already set to false", self.nodes[0].setwalletflag, 'avoid_reuse', False)
120        assert_raises_rpc_error(-8, "Wallet flag is already set to true", self.nodes[1].setwalletflag, 'avoid_reuse', True)
121
122        assert_raises_rpc_error(-8, "Unknown wallet flag: abc", self.nodes[0].setwalletflag, 'abc', True)
123
124        # Create a wallet with avoid reuse, and test that disabling it afterwards persists
125        self.nodes[1].createwallet(wallet_name="avoid_reuse_persist", avoid_reuse=True)
126        w = self.nodes[1].get_wallet_rpc("avoid_reuse_persist")
127        assert_equal(w.getwalletinfo()["avoid_reuse"], True)
128        w.setwalletflag("avoid_reuse", False)
129        assert_equal(w.getwalletinfo()["avoid_reuse"], False)
130        w.unloadwallet()
131        self.nodes[1].loadwallet("avoid_reuse_persist")
132        assert_equal(w.getwalletinfo()["avoid_reuse"], False)
133        w.unloadwallet()
134
135    def test_immutable(self):
136        '''Test immutable wallet flags'''
137        self.log.info("Test immutable wallet flags")
138
139        # Attempt to set the disable_private_keys flag; this should not work
140        assert_raises_rpc_error(-8, "Wallet flag is immutable", self.nodes[1].setwalletflag, 'disable_private_keys')
141
142        tempwallet = ".wallet_avoidreuse.py_test_immutable_wallet.dat"
143
144        # Create a wallet with disable_private_keys set; this should work
145        self.nodes[1].createwallet(wallet_name=tempwallet, disable_private_keys=True)
146        w = self.nodes[1].get_wallet_rpc(tempwallet)
147
148        # Attempt to unset the disable_private_keys flag; this should not work
149        assert_raises_rpc_error(-8, "Wallet flag is immutable", w.setwalletflag, 'disable_private_keys', False)
150
151        # Unload temp wallet
152        self.nodes[1].unloadwallet(tempwallet)
153
154    def test_change_remains_change(self, node):
155        self.log.info("Test that change doesn't turn into non-change when spent")
156
157        reset_balance(node, node.getnewaddress())
158        addr = node.getnewaddress()
159        txid = node.sendtoaddress(addr, 1)
160        out = node.listunspent(minconf=0, query_options={'minimumAmount': 2})
161        assert_equal(len(out), 1)
162        assert_equal(out[0]['txid'], txid)
163        changeaddr = out[0]['address']
164
165        # Make sure it's starting out as change as expected
166        assert node.getaddressinfo(changeaddr)['ischange']
167        for logical_tx in node.listtransactions():
168            assert_not_equal(logical_tx.get('address'), changeaddr)
169
170        # Spend it
171        reset_balance(node, node.getnewaddress())
172
173        # It should still be change
174        assert node.getaddressinfo(changeaddr)['ischange']
175        for logical_tx in node.listtransactions():
176            assert_not_equal(logical_tx.get('address'), changeaddr)
177
178    def test_sending_from_reused_address_without_avoid_reuse(self):
179        '''
180        Test the same as test_sending_from_reused_address_fails, except send the 10 BTC with
181        the avoid_reuse flag set to false. This means the 10 BTC send should succeed,
182        where it fails in test_sending_from_reused_address_fails.
183        '''
184        self.log.info("Test sending from reused address with avoid_reuse=false")
185
186        fundaddr = self.nodes[1].getnewaddress()
187        retaddr = self.nodes[0].getnewaddress()
188
189        self.nodes[0].sendtoaddress(fundaddr, 10)
190        self.generate(self.nodes[0], 1)
191
192        # listunspent should show 1 single, unused 10 btc output
193        assert_unspent(self.nodes[1], total_count=1, total_sum=10, reused_supported=True, reused_count=0)
194        # getbalances should show no used, 10 btc trusted
195        assert_balances(self.nodes[1], mine={"used": 0, "trusted": 10})
196        # node 0 should not show a used entry, as it does not enable avoid_reuse
197        assert "used" not in self.nodes[0].getbalances()["mine"]
198
199        self.nodes[1].sendtoaddress(retaddr, 5)
200        self.generate(self.nodes[0], 1)
201
202        # listunspent should show 1 single, unused 5 btc output
203        assert_unspent(self.nodes[1], total_count=1, total_sum=5, reused_supported=True, reused_count=0)
204        # getbalances should show no used, 5 btc trusted
205        assert_balances(self.nodes[1], mine={"used": 0, "trusted": 5})
206
207        self.nodes[0].sendtoaddress(fundaddr, 10)
208        self.generate(self.nodes[0], 1)
209
210        # listunspent should show 2 total outputs (5, 10 btc), one unused (5), one reused (10)
211        assert_unspent(self.nodes[1], total_count=2, total_sum=15, reused_count=1, reused_sum=10)
212        # getbalances should show 10 used, 5 btc trusted
213        assert_balances(self.nodes[1], mine={"used": 10, "trusted": 5})
214
215        self.nodes[1].sendtoaddress(address=retaddr, amount=10, avoid_reuse=False)
216
217        # listunspent should show 1 total outputs (5 btc), unused
218        assert_unspent(self.nodes[1], total_count=1, total_sum=5, reused_count=0)
219        # getbalances should show no used, 5 btc trusted
220        assert_balances(self.nodes[1], mine={"used": 0, "trusted": 5})
221
222        # node 1 should now have about 5 btc left (for both cases)
223        assert_approx(self.nodes[1].getbalance(), 5, 0.001)
224        assert_approx(self.nodes[1].getbalance(avoid_reuse=False), 5, 0.001)
225
226    def test_sending_from_reused_address_fails(self, second_addr_type):
227        '''
228        Test the simple case where [1] generates a new address A, then
229        [0] sends 10 BTC to A.
230        [1] spends 5 BTC from A. (leaving roughly 5 BTC useable)
231        [0] sends 10 BTC to A again.
232        [1] tries to spend 10 BTC (fails; dirty).
233        [1] tries to spend 4 BTC (succeeds; change address sufficient)
234        '''
235        self.log.info("Test sending from reused {} address fails".format(second_addr_type))
236
237        fundaddr = self.nodes[1].getnewaddress(label="", address_type="legacy")
238        retaddr = self.nodes[0].getnewaddress()
239
240        self.nodes[0].sendtoaddress(fundaddr, 10)
241        self.generate(self.nodes[0], 1)
242
243        # listunspent should show 1 single, unused 10 btc output
244        assert_unspent(self.nodes[1], total_count=1, total_sum=10, reused_supported=True, reused_count=0)
245        # getbalances should show no used, 10 btc trusted
246        assert_balances(self.nodes[1], mine={"used": 0, "trusted": 10})
247
248        self.nodes[1].sendtoaddress(retaddr, 5)
249        self.generate(self.nodes[0], 1)
250

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.