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,967 bytes · SHA-256 9b72dc1d57661dbf… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2024-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
6import re
7
8from test_framework.descriptors import descsum_create
9from test_framework.key import H_POINT
10from test_framework.script import hash160
11from test_framework.test_framework import BitcoinTestFramework
12from test_framework.util import (
13    assert_equal,
14    assert_greater_than,
15    assert_not_equal,
16)
17
18PRIVKEY_RE = re.compile(r"^tr\((.+?)/.+\)#.{8}$")
19PUBKEY_RE = re.compile(r"^tr\((\[.+?\].+?)/.+\)#.{8}$")
20ORIGIN_PATH_RE = re.compile(r"^\[\w{8}(/.*)\].*$")
21MULTIPATH_TWO_RE = re.compile(r"<(\d+);(\d+)>")
22MUSIG_RE = re.compile(r"musig\((.*?)\)")
23PLACEHOLDER_RE = re.compile(r"\$\d")
24
25class WalletMuSigTest(BitcoinTestFramework):
26    wallet_num = 0
27    def set_test_params(self):
28        self.num_nodes = 1
29
30    def skip_test_if_missing_module(self):
31        self.skip_if_no_wallet()
32
33    # Create wallets and extract keys
34    def create_wallets_and_keys_from_pattern(self, pat):
35        wallets = []
36        keys = []
37
38        for musig in MUSIG_RE.findall(pat):
39            for placeholder in PLACEHOLDER_RE.findall(musig):
40                wallet_index = int(placeholder[1:])
41                if wallet_index < len(wallets):
42                    continue
43
44                wallet_name = f"musig_{self.wallet_num}"
45                self.wallet_num += 1
46                self.nodes[0].createwallet(wallet_name)
47                wallet = self.nodes[0].get_wallet_rpc(wallet_name)
48                wallets.append(wallet)
49
50                for priv_desc in wallet.listdescriptors(True)["descriptors"]:
51                    desc = priv_desc["desc"]
52                    if not desc.startswith("tr("):
53                        continue
54                    privkey = PRIVKEY_RE.search(desc).group(1)
55                    break
56                for pub_desc in wallet.listdescriptors()["descriptors"]:
57                    desc = pub_desc["desc"]
58                    if not desc.startswith("tr("):
59                        continue
60                    pubkey = PUBKEY_RE.search(desc).group(1)
61                    # Since the pubkey is derived from the private key that we have, we need
62                    # to extract and insert the origin path from the pubkey as well.
63                    privkey += ORIGIN_PATH_RE.search(pubkey).group(1)
64                    break
65                keys.append((privkey, pubkey))
66
67        return wallets, keys
68
69    # Construct and import each wallet's musig descriptor that
70    # contains the private key from that wallet and pubkeys of the others
71    def construct_and_import_musig_descriptor_in_wallets(self, pat, wallets, keys, only_one_musig_wallet=False):
72        for i, wallet in enumerate(wallets):
73            if only_one_musig_wallet and i > 0:
74                continue
75            desc = pat
76            for j, (priv, pub) in enumerate(keys):
77                if j == i:
78                    desc = desc.replace(f"${i}", priv)
79                else:
80                    desc = desc.replace(f"${j}", pub)
81
82            import_descs = [{
83                "desc": descsum_create(desc),
84                "active": True,
85                "timestamp": "now",
86            }]
87
88            res = wallet.importdescriptors(import_descs)
89            for r in res:
90                assert_equal(r["success"], True)
91
92    def setup_musig_scenario(self, pat):
93        wallets, keys = self.create_wallets_and_keys_from_pattern(pat)
94        self.construct_and_import_musig_descriptor_in_wallets(pat, wallets, keys, only_one_musig_wallet=False)
95
96        # Fund address
97        addr = wallets[0].getnewaddress(address_type="bech32m")
98        for wallet in wallets[1:]:
99            assert_equal(addr, wallet.getnewaddress(address_type="bech32m"))
100
101        self.def_wallet.sendtoaddress(addr, 10)
102        self.generate(self.nodes[0], 1)
103
104        # Create PSBT
105        utxo = wallets[0].listunspent()[0]
106        psbt = wallets[0].walletcreatefundedpsbt(
107            outputs=[{self.def_wallet.getnewaddress(): 5}],
108            inputs=[utxo],
109            change_type="bech32m",
110            changePosition=1
111        )["psbt"]
112
113        return wallets, psbt
114
115    def assert_musig_signer_data(self, first, second, different_field):
116        assert_equal(first["participant_pubkey"], second["participant_pubkey"])
117        assert_equal(first["aggregate_pubkey"], second["aggregate_pubkey"])
118        if "leaf_hash" in first:
119            assert_equal(first["leaf_hash"], second["leaf_hash"])
120        else:
121            assert "leaf_hash" not in second
122
123        assert_not_equal(first[different_field], second[different_field])
124
125    def assert_musig_aggregate_in_script(self, signer_data, pattern, psbtin):
126        pubkey = signer_data["aggregate_pubkey"][2:]
127        if "pkh" in pattern or "pk_h" in pattern:
128            pubkey = hash160(bytes.fromhex(pubkey)).hex()
129        if pubkey in psbtin["witness_utxo"]["scriptPubKey"]["hex"]:
130            return
131        elif "taproot_scripts" in psbtin:
132            for leaf_scripts in psbtin["taproot_scripts"]:
133                if pubkey in leaf_scripts["script"]:
134                    break
135            else:
136                assert False, "Aggregate pubkey not seen as output key, or in any scripts"
137        else:
138            assert False, "Aggregate pubkey not seen as output key or internal key"
139
140    def test_failure_case_1(self, comment, pat):
141        self.log.info(f"Testing {comment}")
142        wallets, psbt = self.setup_musig_scenario(pat)
143
144        # Only 2 out of 3 participants provide nonces
145        nonce_psbts = []
146        for i in range(2):
147            proc = wallets[i].walletprocesspsbt(psbt=psbt)
148            nonce_psbts.append(proc["psbt"])
149
150        comb_nonce_psbt = self.nodes[0].combinepsbt(nonce_psbts)
151
152        # Attempt to create partial sigs. This should not complete due to the
153        # missing nonce.
154        for wallet in wallets[:2]:
155            proc = wallet.walletprocesspsbt(psbt=comb_nonce_psbt)
156            assert_equal(proc["complete"], False)
157            # No partial sigs are created
158            dec = self.nodes[0].decodepsbt(proc["psbt"])
159            # There are still only two nonces
160            assert_equal(len(dec["inputs"][0].get("musig2_pubnonces", [])), 2)
161
162    def test_failure_case_2(self, comment, pat):
163        self.log.info(f"Testing {comment}")
164        wallets, psbt = self.setup_musig_scenario(pat)
165        nonce_psbts = [w.walletprocesspsbt(psbt=psbt)["psbt"] for w in wallets]
166        comb_nonce_psbt = self.nodes[0].combinepsbt(nonce_psbts)
167
168        # Only 2 out of 3 provide partial sigs
169        psig_psbts = []
170        for i in range(2):
171            proc = wallets[i].walletprocesspsbt(psbt=comb_nonce_psbt)
172            psig_psbts.append(proc["psbt"])
173
174        comb_psig_psbt = self.nodes[0].combinepsbt(psig_psbts)
175
176        # Finalization fails due to missing partial sig
177        finalized = self.nodes[0].finalizepsbt(comb_psig_psbt)
178        assert_equal(finalized["complete"], False)
179
180        # Still only two partial sigs in combined PSBT
181        dec = self.nodes[0].decodepsbt(comb_psig_psbt)
182        assert_equal(len(dec["inputs"][0]["musig2_partial_sigs"]), 2)
183
184    def test_failure_case_3(self, comment, pat):
185        self.log.info(f"Testing {comment}")
186        wallets, psbt = self.setup_musig_scenario(pat)
187        nonce_psbts = [w.walletprocesspsbt(psbt=psbt)["psbt"] for w in wallets]
188        comb_nonce_psbt = self.nodes[0].combinepsbt(nonce_psbts)
189
190        finalized = self.nodes[0].finalizepsbt(comb_nonce_psbt)
191        assert_equal(finalized["complete"], False)
192
193        dec = self.nodes[0].decodepsbt(comb_nonce_psbt)
194        assert "musig2_pubnonces" in dec["inputs"][0]
195        assert "musig2_partial_sigs" not in dec["inputs"][0]
196
197    def test_success_case(self, comment, pattern, sighash_type=None, scriptpath=False, nosign_wallets=None, only_one_musig_wallet=False):
198        self.log.info(f"Testing {comment}")
199        has_internal = MULTIPATH_TWO_RE.search(pattern) is not None
200
201        pat = pattern.replace("$H", H_POINT)
202        wallets, keys = self.create_wallets_and_keys_from_pattern(pat)
203        self.construct_and_import_musig_descriptor_in_wallets(pat, wallets, keys, only_one_musig_wallet)
204
205        # The participant maps are keyed by the aggregate pubkey, which does not depend on the
206        # order of the participants nor on the derivation applied to the aggregate.
207        expected_participant_maps = len({tuple(sorted(musig.split(","))) for musig in MUSIG_RE.findall(pat)})
208        expected_pubnonces = 0
209        expected_partial_sigs = 0
210        for musig in MUSIG_RE.findall(pat):
211            musig_partial_sigs = 0
212            for placeholder in PLACEHOLDER_RE.findall(musig):
213                wallet_index = int(placeholder[1:])
214                if nosign_wallets is None or wallet_index not in nosign_wallets:
215                    expected_pubnonces += 1
216                else:
217                    musig_partial_sigs = None
218                if musig_partial_sigs is not None:
219                    musig_partial_sigs += 1
220                if wallet_index < len(wallets):
221                    continue
222            if musig_partial_sigs is not None:
223                expected_partial_sigs += musig_partial_sigs
224
225        # Check that the wallets agree on the same musig address
226        addr = None
227        change_addr = None
228        for i, wallet in enumerate(wallets):
229            if only_one_musig_wallet and i > 0:
230                continue
231            if addr is None:
232                addr = wallet.getnewaddress(address_type="bech32m")
233            else:
234                assert_equal(addr, wallet.getnewaddress(address_type="bech32m"))
235            if has_internal:
236                if change_addr is None:
237                    change_addr = wallet.getrawchangeaddress(address_type="bech32m")
238                else:
239                    assert_equal(change_addr, wallet.getrawchangeaddress(address_type="bech32m"))
240
241        # Fund that address
242        self.def_wallet.sendtoaddress(addr, 10)
243        self.generate(self.nodes[0], 1)
244
245        # Spend that UTXO
246        utxo = None
247        for i, wallet in enumerate(wallets):
248            if only_one_musig_wallet and i > 0:
249                continue
250            if utxo is None:

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.