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