|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# Copyright (c) 2021 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 a basic M-of-N multisig setup between multiple people using descriptor wallets and PSBTs, as well as a signing flow. |
| 6 | +
|
| 7 | +This is meant to be documentation as much as functional tests, so it is kept as simple and readable as possible. |
| 8 | +""" |
| 9 | + |
| 10 | +from test_framework.address import base58_to_byte |
| 11 | +from test_framework.test_framework import BitcoinTestFramework |
| 12 | +from test_framework.util import ( |
| 13 | + assert_approx, |
| 14 | + assert_equal, |
| 15 | +) |
| 16 | + |
| 17 | + |
| 18 | +class WalletMultisigDescriptorPSBTTest(BitcoinTestFramework): |
| 19 | + def set_test_params(self): |
| 20 | + self.num_nodes = 3 |
| 21 | + self.setup_clean_chain = True |
| 22 | + self.wallet_names = [] |
| 23 | + self.extra_args = [["-keypool=100"]] * self.num_nodes |
| 24 | + |
| 25 | + def skip_test_if_missing_module(self): |
| 26 | + self.skip_if_no_wallet() |
| 27 | + self.skip_if_no_sqlite() |
| 28 | + |
| 29 | + @staticmethod |
| 30 | + def _get_xpub(wallet): |
| 31 | + """Extract the wallet's xpubs using `listdescriptors` and pick the one from the `pkh` descriptor since it's least likely to be accidentally reused (legacy addresses).""" |
| 32 | + descriptor = next(filter(lambda d: d["desc"].startswith("pkh"), wallet.listdescriptors()["descriptors"])) |
| 33 | + return descriptor["desc"].split("]")[-1].split("/")[0] |
| 34 | + |
| 35 | + @staticmethod |
| 36 | + def _check_psbt(psbt, to, value, multisig): |
| 37 | + """Helper function for any of the N participants to check the psbt with decodepsbt and verify it is OK before signing.""" |
| 38 | + tx = multisig.decodepsbt(psbt)["tx"] |
| 39 | + amount = 0 |
| 40 | + for vout in tx["vout"]: |
| 41 | + address = vout["scriptPubKey"]["address"] |
| 42 | + assert_equal(multisig.getaddressinfo(address)["ischange"], address != to) |
| 43 | + if address == to: |
| 44 | + amount += vout["value"] |
| 45 | + assert_approx(amount, float(value), vspan=0.001) |
| 46 | + |
| 47 | + def participants_create_multisigs(self, xpubs): |
| 48 | + """The multisig is created by importing the following descriptors. The resulting wallet is watch-only and every participant can do this.""" |
| 49 | + # some simple validation |
| 50 | + assert_equal(len(xpubs), self.N) |
| 51 | + # a sanity-check/assertion, this will throw if the base58 checksum of any of the provided xpubs are invalid |
| 52 | + for xpub in xpubs: |
| 53 | + base58_to_byte(xpub) |
| 54 | + |
| 55 | + for i, node in enumerate(self.nodes): |
| 56 | + node.createwallet(wallet_name=f"{self.name}_{i}", blank=True, descriptors=True, disable_private_keys=True) |
| 57 | + multisig = node.get_wallet_rpc(f"{self.name}_{i}") |
| 58 | + external = multisig.getdescriptorinfo(f"wsh(sortedmulti({self.M},{f'/0/*,'.join(xpubs)}/0/*))") |
| 59 | + internal = multisig.getdescriptorinfo(f"wsh(sortedmulti({self.M},{f'/1/*,'.join(xpubs)}/1/*))") |
| 60 | + result = multisig.importdescriptors([ |
| 61 | + { # receiving addresses (internal: False) |
| 62 | + "desc": external["descriptor"], |
| 63 | + "active": True, |
| 64 | + "internal": False, |
| 65 | + "timestamp": "now", |
| 66 | + }, |
| 67 | + { # change addresses (internal: True) |
| 68 | + "desc": internal["descriptor"], |
| 69 | + "active": True, |
| 70 | + "internal": True, |
| 71 | + "timestamp": "now", |
| 72 | + }, |
| 73 | + ]) |
| 74 | + assert all(r["success"] for r in result) |
| 75 | + yield multisig |
| 76 | + |
| 77 | + def run_test(self): |
| 78 | + self.M = 2 |
| 79 | + self.N = self.num_nodes |
| 80 | + self.name = f"{self.M}_of_{self.N}_multisig" |
| 81 | + self.log.info(f"Testing {self.name}...") |
| 82 | + |
| 83 | + participants = { |
| 84 | + # Every participant generates an xpub. The most straightforward way is to create a new descriptor wallet. |
| 85 | + # This wallet will be the participant's `signer` for the resulting multisig. Avoid reusing this wallet for any other purpose (for privacy reasons). |
| 86 | + "signers": [node.get_wallet_rpc(node.createwallet(wallet_name=f"participant_{self.nodes.index(node)}", descriptors=True)["name"]) for node in self.nodes], |
| 87 | + # After participants generate and exchange their xpubs they will each create their own watch-only multisig. |
| 88 | + # Note: these multisigs are all the same, this justs highlights that each participant can independently verify everything on their own node. |
| 89 | + "multisigs": [] |
| 90 | + } |
| 91 | + |
| 92 | + self.log.info("Generate and exchange xpubs...") |
| 93 | + xpubs = [self._get_xpub(signer) for signer in participants["signers"]] |
| 94 | + |
| 95 | + self.log.info("Every participant imports the following descriptors to create the watch-only multisig...") |
| 96 | + participants["multisigs"] = list(self.participants_create_multisigs(xpubs)) |
| 97 | + |
| 98 | + self.log.info("Check that every participant's multisig generates the same addresses...") |
| 99 | + for _ in range(10): # we check that the first 10 generated addresses are the same for all participant's multisigs |
| 100 | + receive_addresses = [multisig.getnewaddress() for multisig in participants["multisigs"]] |
| 101 | + all(address == receive_addresses[0] for address in receive_addresses) |
| 102 | + change_addresses = [multisig.getrawchangeaddress() for multisig in participants["multisigs"]] |
| 103 | + all(address == change_addresses[0] for address in change_addresses) |
| 104 | + |
| 105 | + self.log.info("Get a mature utxo to send to the multisig...") |
| 106 | + coordinator_wallet = participants["signers"][0] |
| 107 | + coordinator_wallet.generatetoaddress(101, coordinator_wallet.getnewaddress()) |
| 108 | + |
| 109 | + deposit_amount = 6.15 |
| 110 | + multisig_receiving_address = participants["multisigs"][0].getnewaddress() |
| 111 | + self.log.info("Send funds to the resulting multisig receiving address...") |
| 112 | + coordinator_wallet.sendtoaddress(multisig_receiving_address, deposit_amount) |
| 113 | + self.nodes[0].generate(1) |
| 114 | + self.sync_all() |
| 115 | + for participant in participants["multisigs"]: |
| 116 | + assert_approx(participant.getbalance(), deposit_amount, vspan=0.001) |
| 117 | + |
| 118 | + self.log.info("Send a transaction from the multisig!") |
| 119 | + to = participants["signers"][self.N - 1].getnewaddress() |
| 120 | + value = 1 |
| 121 | + self.log.info("First, make a sending transaction, created using `walletcreatefundedpsbt` (anyone can initiate this)...") |
| 122 | + psbt = participants["multisigs"][0].walletcreatefundedpsbt(inputs=[], outputs={to: value}, options={"feeRate": 0.00010}) |
| 123 | + |
| 124 | + psbts = [] |
| 125 | + self.log.info("Now at least M users check the psbt with decodepsbt and (if OK) signs it with walletprocesspsbt...") |
| 126 | + for m in range(self.M): |
| 127 | + signers_multisig = participants["multisigs"][m] |
| 128 | + self._check_psbt(psbt["psbt"], to, value, signers_multisig) |
| 129 | + signing_wallet = participants["signers"][m] |
| 130 | + partially_signed_psbt = signing_wallet.walletprocesspsbt(psbt["psbt"]) |
| 131 | + psbts.append(partially_signed_psbt["psbt"]) |
| 132 | + |
| 133 | + self.log.info("Finally, collect the signed PSBTs with combinepsbt, finalizepsbt, then broadcast the resulting transaction...") |
| 134 | + combined = coordinator_wallet.combinepsbt(psbts) |
| 135 | + finalized = coordinator_wallet.finalizepsbt(combined) |
| 136 | + coordinator_wallet.sendrawtransaction(finalized["hex"]) |
| 137 | + |
| 138 | + self.log.info("Check that balances are correct after the transaction has been included in a block.") |
| 139 | + self.nodes[0].generate(1) |
| 140 | + self.sync_all() |
| 141 | + assert_approx(participants["multisigs"][0].getbalance(), deposit_amount - value, vspan=0.001) |
| 142 | + assert_equal(participants["signers"][self.N - 1].getbalance(), value) |
| 143 | + |
| 144 | + self.log.info("Send another transaction from the multisig, this time with a daisy chained signing flow (one after another in series)!") |
| 145 | + psbt = participants["multisigs"][0].walletcreatefundedpsbt(inputs=[], outputs={to: value}, options={"feeRate": 0.00010}) |
| 146 | + for m in range(self.M): |
| 147 | + signers_multisig = participants["multisigs"][m] |
| 148 | + self._check_psbt(psbt["psbt"], to, value, signers_multisig) |
| 149 | + signing_wallet = participants["signers"][m] |
| 150 | + psbt = signing_wallet.walletprocesspsbt(psbt["psbt"]) |
| 151 | + assert_equal(psbt["complete"], m == self.M - 1) |
| 152 | + finalized = coordinator_wallet.finalizepsbt(psbt["psbt"]) |
| 153 | + coordinator_wallet.sendrawtransaction(finalized["hex"]) |
| 154 | + |
| 155 | + self.log.info("Check that balances are correct after the transaction has been included in a block.") |
| 156 | + self.nodes[0].generate(1) |
| 157 | + self.sync_all() |
| 158 | + assert_approx(participants["multisigs"][0].getbalance(), deposit_amount - (value * 2), vspan=0.001) |
| 159 | + assert_equal(participants["signers"][self.N - 1].getbalance(), value * 2) |
| 160 | + |
| 161 | + |
| 162 | +if __name__ == "__main__": |
| 163 | + WalletMultisigDescriptorPSBTTest().main() |
0 commit comments