wallet_createwalletdescriptor.py
1 #!/usr/bin/env python3 2 # Copyright (c) 2023 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 wallet createwalletdescriptor RPC.""" 6 7 from test_framework.descriptors import descsum_create 8 from test_framework.test_framework import BitcoinTestFramework 9 from test_framework.util import ( 10 assert_equal, 11 assert_raises_rpc_error, 12 ) 13 from test_framework.wallet_util import WalletUnlock 14 15 16 class WalletCreateDescriptorTest(BitcoinTestFramework): 17 def set_test_params(self): 18 self.setup_clean_chain = True 19 self.num_nodes = 1 20 21 def skip_test_if_missing_module(self): 22 self.skip_if_no_wallet() 23 24 def run_test(self): 25 self.test_basic() 26 self.test_imported_other_keys() 27 self.test_encrypted() 28 29 def test_basic(self): 30 def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name) 31 self.nodes[0].createwallet("blank", blank=True) 32 wallet = self.nodes[0].get_wallet_rpc("blank") 33 34 xpub_info = def_wallet.gethdkeys(private=True) 35 xpub = xpub_info[0]["xpub"] 36 xprv = xpub_info[0]["xprv"] 37 expected_descs = [] 38 for desc in def_wallet.listdescriptors()["descriptors"]: 39 if desc["desc"].startswith("wpkh("): 40 expected_descs.append(desc["desc"]) 41 42 assert_raises_rpc_error(-5, "Unable to determine which HD key to use from active descriptors. Please specify with 'hdkey'", wallet.createwalletdescriptor, "bech32") 43 assert_raises_rpc_error(-5, f"Private key for {xpub} is not known", wallet.createwalletdescriptor, type="bech32", hdkey=xpub) 44 45 self.log.info("Test createwalletdescriptor after importing active descriptor to blank wallet") 46 # Import one active descriptor 47 assert_equal(wallet.importdescriptors([{"desc": descsum_create(f"pkh({xprv}/44h/2h/0h/0/0/*)"), "timestamp": "now", "active": True}])[0]["success"], True) 48 assert_equal(len(wallet.listdescriptors()["descriptors"]), 1) 49 assert_equal(len(wallet.gethdkeys()), 1) 50 51 new_descs = wallet.createwalletdescriptor("bech32")["descs"] 52 assert_equal(len(new_descs), 2) 53 assert_equal(len(wallet.gethdkeys()), 1) 54 assert_equal(new_descs, expected_descs) 55 56 self.log.info("Test descriptor creation options") 57 old_descs = set([(d["desc"], d["active"], d["internal"]) for d in wallet.listdescriptors(private=True)["descriptors"]]) 58 wallet.createwalletdescriptor(type="bech32m", internal=False) 59 curr_descs = set([(d["desc"], d["active"], d["internal"]) for d in wallet.listdescriptors(private=True)["descriptors"]]) 60 new_descs = list(curr_descs - old_descs) 61 assert_equal(len(new_descs), 1) 62 assert_equal(len(wallet.gethdkeys()), 1) 63 assert_equal(new_descs[0][0], descsum_create(f"tr({xprv}/86h/1h/0h/0/*)")) 64 assert_equal(new_descs[0][1], True) 65 assert_equal(new_descs[0][2], False) 66 67 old_descs = curr_descs 68 wallet.createwalletdescriptor(type="bech32m", internal=True) 69 curr_descs = set([(d["desc"], d["active"], d["internal"]) for d in wallet.listdescriptors(private=True)["descriptors"]]) 70 new_descs = list(curr_descs - old_descs) 71 assert_equal(len(new_descs), 1) 72 assert_equal(len(wallet.gethdkeys()), 1) 73 assert_equal(new_descs[0][0], descsum_create(f"tr({xprv}/86h/1h/0h/1/*)")) 74 assert_equal(new_descs[0][1], True) 75 assert_equal(new_descs[0][2], True) 76 77 def test_imported_other_keys(self): 78 self.log.info("Test createwalletdescriptor with multiple keys in active descriptors") 79 def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name) 80 self.nodes[0].createwallet("multiple_keys") 81 wallet = self.nodes[0].get_wallet_rpc("multiple_keys") 82 83 wallet_xpub = wallet.gethdkeys()[0]["xpub"] 84 85 xpub_info = def_wallet.gethdkeys(private=True) 86 xpub = xpub_info[0]["xpub"] 87 xprv = xpub_info[0]["xprv"] 88 89 assert_equal(wallet.importdescriptors([{"desc": descsum_create(f"wpkh({xprv}/0/0/*)"), "timestamp": "now", "active": True}])[0]["success"], True) 90 assert_equal(len(wallet.gethdkeys()), 2) 91 92 assert_raises_rpc_error(-5, "Unable to determine which HD key to use from active descriptors. Please specify with 'hdkey'", wallet.createwalletdescriptor, "bech32") 93 assert_raises_rpc_error(-4, "Descriptor already exists", wallet.createwalletdescriptor, type="bech32m", hdkey=wallet_xpub) 94 assert_raises_rpc_error(-5, "Unable to parse HD key. Please provide a valid xpub", wallet.createwalletdescriptor, type="bech32m", hdkey=xprv) 95 96 # Able to replace tr() descriptor with other hd key 97 wallet.createwalletdescriptor(type="bech32m", hdkey=xpub) 98 99 def test_encrypted(self): 100 self.log.info("Test createwalletdescriptor with encrypted wallets") 101 def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name) 102 self.nodes[0].createwallet("encrypted", blank=True, passphrase="pass") 103 wallet = self.nodes[0].get_wallet_rpc("encrypted") 104 105 xpub_info = def_wallet.gethdkeys(private=True) 106 xprv = xpub_info[0]["xprv"] 107 108 with WalletUnlock(wallet, "pass"): 109 assert_equal(wallet.importdescriptors([{"desc": descsum_create(f"wpkh({xprv}/0/0/*)"), "timestamp": "now", "active": True}])[0]["success"], True) 110 assert_equal(len(wallet.gethdkeys()), 1) 111 112 assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first.", wallet.createwalletdescriptor, type="bech32m") 113 114 with WalletUnlock(wallet, "pass"): 115 wallet.createwalletdescriptor(type="bech32m") 116 117 118 119 if __name__ == '__main__': 120 WalletCreateDescriptorTest(__file__).main()