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.

18,051 bytes · SHA-256 67468302d78c8d72… · 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 that the wallet can send and receive using all combinations of address types.
6
7There are 5 nodes-under-test:
8    - node0 uses legacy addresses
9    - node1 uses p2sh/segwit addresses
10    - node2 uses p2sh/segwit addresses and bech32 addresses for change
11    - node3 uses bech32 addresses
12    - node4 uses a p2sh/segwit addresses for change
13
14node5 exists to generate new blocks.
15
16## Multisig address test
17
18Test that adding a multisig address with:
19    - an uncompressed pubkey always gives a legacy address
20    - only compressed pubkeys gives the an `-addresstype` address
21
22## Sending to address types test
23
24A series of tests, iterating over node0-node4. In each iteration of the test, one node sends:
25    - 10/101th of its balance to itself (using getrawchangeaddress for single key addresses)
26    - 20/101th to the next node
27    - 30/101th to the node after that
28    - 40/101th to the remaining node
29    - 1/101th remains as fee+change
30
31Iterate over each node for single key addresses, and then over each node for
32multisig addresses.
33
34Repeat test, but with explicit address_type parameters passed to getnewaddress
35and getrawchangeaddress:
36    - node0 and node3 send to p2sh.
37    - node1 sends to bech32.
38    - node2 sends to legacy.
39
40As every node sends coins after receiving, this also
41verifies that spending coins sent to all these address types works.
42
43## Change type test
44
45Test that the nodes generate the correct change address type:
46    - node0 always uses a legacy change address.
47    - node1 uses a bech32 addresses for change if any destination address is bech32.
48    - node2 always uses a bech32 address for change
49    - node3 always uses a bech32 address for change
50    - node4 always uses p2sh/segwit output for change.
51"""
52
53from decimal import Decimal
54import itertools
55
56from test_framework.blocktools import COINBASE_MATURITY
57from test_framework.test_framework import BitcoinTestFramework
58from test_framework.descriptors import (
59    descsum_create,
60    descsum_check,
61)
62from test_framework.util import (
63    assert_equal,
64    assert_greater_than,
65    assert_raises_rpc_error,
66)
67
68class AddressTypeTest(BitcoinTestFramework):
69    def set_test_params(self):
70        self.num_nodes = 6
71        self.extra_args = [
72            ["-addresstype=legacy"],
73            ["-addresstype=p2sh-segwit"],
74            ["-addresstype=p2sh-segwit", "-changetype=bech32"],
75            ["-addresstype=bech32"],
76            ["-changetype=p2sh-segwit"],
77            [],
78        ]
79        # whitelist peers to speed up tx relay / mempool sync
80        self.noban_tx_relay = True
81
82    def skip_test_if_missing_module(self):
83        self.skip_if_no_wallet()
84
85    def setup_network(self):
86        self.setup_nodes()
87
88        # Fully mesh-connect nodes for faster mempool sync
89        for i, j in itertools.product(range(self.num_nodes), repeat=2):
90            if i > j:
91                self.connect_nodes(i, j)
92        self.sync_all()
93
94    def get_balances(self, key='trusted'):
95        """Return a list of balances."""
96        return [self.nodes[i].getbalances()['mine'][key] for i in range(4)]
97
98    def test_address(self, node, address, multisig, typ):
99        """Run sanity checks on an address."""
100        info = self.nodes[node].getaddressinfo(address)
101        assert self.nodes[node].validateaddress(address)['isvalid']
102        assert_equal(info.get('solvable'), True)
103
104        if not multisig and typ == 'legacy':
105            # P2PKH
106            assert not info['isscript']
107            assert not info['iswitness']
108            assert 'pubkey' in info
109        elif not multisig and typ == 'p2sh-segwit':
110            # P2SH-P2WPKH
111            assert info['isscript']
112            assert not info['iswitness']
113            assert_equal(info['script'], 'witness_v0_keyhash')
114            assert 'pubkey' in info
115        elif not multisig and typ == 'bech32':
116            # P2WPKH
117            assert not info['isscript']
118            assert info['iswitness']
119            assert_equal(info['witness_version'], 0)
120            assert_equal(len(info['witness_program']), 40)
121            assert 'pubkey' in info
122        elif not multisig and typ == "bech32m":
123            # P2TR single sig
124            assert info["isscript"]
125            assert info["iswitness"]
126            assert_equal(info["witness_version"], 1)
127            assert_equal(len(info["witness_program"]), 64)
128        elif typ == 'legacy':
129            # P2SH-multisig
130            assert info['isscript']
131            assert_equal(info['script'], 'multisig')
132            assert not info['iswitness']
133            assert 'pubkeys' in info
134        elif typ == 'p2sh-segwit':
135            # P2SH-P2WSH-multisig
136            assert info['isscript']
137            assert_equal(info['script'], 'witness_v0_scripthash')
138            assert not info['iswitness']
139            assert info['embedded']['isscript']
140            assert_equal(info['embedded']['script'], 'multisig')
141            assert info['embedded']['iswitness']
142            assert_equal(info['embedded']['witness_version'], 0)
143            assert_equal(len(info['embedded']['witness_program']), 64)
144            assert 'pubkeys' in info['embedded']
145        elif typ == 'bech32':
146            # P2WSH-multisig
147            assert info['isscript']
148            assert_equal(info['script'], 'multisig')
149            assert info['iswitness']
150            assert_equal(info['witness_version'], 0)
151            assert_equal(len(info['witness_program']), 64)
152            assert 'pubkeys' in info
153        else:
154            # Unknown type
155            assert False
156
157    def test_desc(self, node, address, multisig, typ, utxo):
158        """Run sanity checks on a descriptor reported by getaddressinfo."""
159        info = self.nodes[node].getaddressinfo(address)
160        assert 'desc' in info
161        assert_equal(info['desc'], utxo['desc'])
162        assert self.nodes[node].validateaddress(address)['isvalid']
163
164        # Use a ridiculously roundabout way to find the key origin info through
165        # the PSBT logic. However, this does test consistency between the PSBT reported
166        # fingerprints/paths and the descriptor logic.
167        psbt = self.nodes[node].createpsbt([{'txid':utxo['txid'], 'vout':utxo['vout']}],[{address:0.00010000}])
168        psbt = self.nodes[node].walletprocesspsbt(psbt, False, "ALL", True)
169        decode = self.nodes[node].decodepsbt(psbt['psbt'])
170        key_descs = {}
171        for deriv in decode['inputs'][0]['bip32_derivs']:
172            assert_equal(len(deriv['master_fingerprint']), 8)
173            assert_equal(deriv['path'][0], 'm')
174            key_descs[deriv['pubkey']] = '[' + deriv['master_fingerprint'] + deriv['path'][1:].replace("'","h") + ']' + deriv['pubkey']
175
176        # Verify the descriptor checksum against the Python implementation
177        assert descsum_check(info['desc'])
178        # Verify that stripping the checksum and recreating it using Python roundtrips
179        assert_equal(info['desc'], descsum_create(info['desc'][:-9]))
180        # Verify that stripping the checksum and feeding it to getdescriptorinfo roundtrips
181        assert_equal(info['desc'], self.nodes[0].getdescriptorinfo(info['desc'][:-9])['descriptor'])
182        assert_equal(info['desc'][-8:], self.nodes[0].getdescriptorinfo(info['desc'][:-9])['checksum'])
183        # Verify that keeping the checksum and feeding it to getdescriptorinfo roundtrips
184        assert_equal(info['desc'], self.nodes[0].getdescriptorinfo(info['desc'])['descriptor'])
185        assert_equal(info['desc'][-8:], self.nodes[0].getdescriptorinfo(info['desc'])['checksum'])
186
187        if not multisig and typ == 'legacy':
188            # P2PKH
189            assert_equal(info['desc'], descsum_create("pkh(%s)" % key_descs[info['pubkey']]))
190        elif not multisig and typ == 'p2sh-segwit':
191            # P2SH-P2WPKH
192            assert_equal(info['desc'], descsum_create("sh(wpkh(%s))" % key_descs[info['pubkey']]))
193        elif not multisig and typ == 'bech32':
194            # P2WPKH
195            assert_equal(info['desc'], descsum_create("wpkh(%s)" % key_descs[info['pubkey']]))
196        elif typ == 'legacy':
197            # P2SH-multisig
198            assert_equal(info['desc'], descsum_create("sh(multi(2,%s,%s))" % (key_descs[info['pubkeys'][0]], key_descs[info['pubkeys'][1]])))
199        elif typ == 'p2sh-segwit':
200            # P2SH-P2WSH-multisig
201            assert_equal(info['desc'], descsum_create("sh(wsh(multi(2,%s,%s)))" % (key_descs[info['embedded']['pubkeys'][0]], key_descs[info['embedded']['pubkeys'][1]])))
202        elif typ == 'bech32':
203            # P2WSH-multisig
204            assert_equal(info['desc'], descsum_create("wsh(multi(2,%s,%s))" % (key_descs[info['pubkeys'][0]], key_descs[info['pubkeys'][1]])))
205        else:
206            # Unknown type
207            assert False
208
209    def test_change_output_type(self, node_sender, destinations, expected_type):
210        txid = self.nodes[node_sender].sendmany(dummy="", amounts=dict.fromkeys(destinations, 0.001))
211        tx = self.nodes[node_sender].gettransaction(txid=txid, verbose=True)['decoded']
212
213        # Make sure the transaction has change:
214        assert_equal(len(tx["vout"]), len(destinations) + 1)
215
216        # Make sure the destinations are included, and remove them:
217        output_addresses = [vout['scriptPubKey']['address'] for vout in tx["vout"]]
218        change_addresses = [d for d in output_addresses if d not in destinations]
219        assert_equal(len(change_addresses), 1)
220
221        self.log.debug("Check if change address " + change_addresses[0] + " is " + expected_type)
222        self.test_address(node_sender, change_addresses[0], multisig=False, typ=expected_type)
223
224    def run_test(self):
225        # Mine 101 blocks on node5 to bring nodes out of IBD and make sure that
226        # no coinbases are maturing for the nodes-under-test during the test
227        self.generate(self.nodes[5], COINBASE_MATURITY + 1)
228
229        compressed_1 = "0296b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52"
230        compressed_2 = "037211a824f55b505228e4c3d5194c1fcfaa15a456abdf37f9b9d97a4040afc073"
231
232        do_multisigs = [False]
233
234        for explicit_type, multisig, from_node in itertools.product([False, True], do_multisigs, range(4)):
235            address_type = None
236            if explicit_type and not multisig:
237                if from_node == 1:
238                    address_type = 'bech32'
239                elif from_node == 0 or from_node == 3:
240                    address_type = 'p2sh-segwit'
241                else:
242                    address_type = 'legacy'
243            self.log.info("Sending from node {} ({}) with{} multisig using {}".format(from_node, self.extra_args[from_node], "" if multisig else "out", "default" if address_type is None else address_type))
244            old_balances = self.get_balances()
245            self.log.debug("Old balances are {}".format(old_balances))
246            to_send = (old_balances[from_node] / (COINBASE_MATURITY + 1)).quantize(Decimal("0.00000001"))
247            sends = {}
248            addresses = {}
249
250            self.log.debug("Prepare sends")

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.