Merge bitcoin/bitcoin#29130: wallet: Add `createwalletdescriptor` and `gethdkeys` RPCs for adding new automatically generated descriptors

746b6d8839 test: Add test for createwalletdescriptor (Ava Chow)
2402b63062 wallet: Test upgrade of pre-taproot wallet to have tr() descriptors (Ava Chow)
460ae1bf67 wallet, rpc: Add createwalletdescriptor RPC (Ava Chow)
8e1a475062 wallet: Be able to retrieve single key from descriptors (Ava Chow)
85b1fb19dd wallet: Add GetActiveHDPubKeys to retrieve xpubs from active descriptors (Ava Chow)
73926f2d31 wallet, descspkm: Refactor wallet descriptor generation to standalone func (Andrew Chow)
54e74f46ea wallet: Refactor function for single DescSPKM setup (Andrew Chow)
3b09d0eb7f tests: Test for gethdkeys (Ava Chow)
5febe28c9e wallet, rpc: Add gethdkeys RPC (Ava Chow)
66632e5c24 wallet: Add IsActiveScriptPubKeyMan (Ava Chow)
fa6a259985 desc spkm: Add functions to retrieve specific private keys (Ava Chow)
fe67841464 descriptor: Be able to get the pubkeys involved in a descriptor (Ava Chow)
ef6745879d key: Add constructor for CExtKey that takes CExtPubKey and CKey (Ava Chow)

Pull request description:

  This PR adds a `createwalletdescriptor` RPC which allows users to add new automatically generated descriptors to their wallet, e.g. to upgrade a 0.21.x wallet to contain a taproot descriptor. This RPC takes 3 arguments: the output type to create a descriptor for, whether the descriptor will be internal or external, and the HD key to use if the user wishes to use a specific key. The HD key is an optional parameter. If it is not specified, the wallet will use the key shared by the active descriptors, if they are all single key. For most users in the expected upgrade scenario, this should be sufficient. In more advanced cases, the user must specify the HD key to use.

  Currently, specified HD keys must already exist in the wallet. To make it easier for the user to know, `gethdkeys` is also added to list out the HD keys in use by all of the descriptors in the wallet. This will include all HD keys, whether we have the private key, for it, which descriptors use it and their activeness, and optionally the extended private key. In this way, users with more complex wallets will be still be able to get HD keys from their wallet for use in other scenarios, and if they want to use `createwalletdescriptor`, they can easily get the keys that they can specify to it.

  See also https://github.com/bitcoin/bitcoin/pull/26728#issuecomment-1866961865

ACKs for top commit:
  Sjors:
    re-utACK 746b6d8839
  furszy:
    ACK 746b6d8
  ryanofsky:
    Code review ACK 746b6d8839, and this looks ready to merge. There were various suggested changes since last review where main change seems to be switching `gethdkeys` output to use normalized descriptors (removing hardened path components).

Tree-SHA512: f2849101e6fbf1f59cb031eaaaee97af5b1ae92aaab54c5716940d210f08ab4fc952df2725b636596cd5747b8f5beb1a7a533425bc10d09da02659473516fbda
This commit is contained in:
Ryan Ofsky 2024-03-29 06:27:43 -04:00
commit 4373414d26
No known key found for this signature in database
GPG Key ID: 46800E30FC748A66
16 changed files with 775 additions and 63 deletions

View File

@ -223,6 +223,12 @@ struct CExtKey {
a.key == b.key;
}
CExtKey() = default;
CExtKey(const CExtPubKey& xpub, const CKey& key_in) : nDepth(xpub.nDepth), nChild(xpub.nChild), chaincode(xpub.chaincode), key(key_in)
{
std::copy(xpub.vchFingerprint, xpub.vchFingerprint + sizeof(xpub.vchFingerprint), vchFingerprint);
}
void Encode(unsigned char code[BIP32_EXTKEY_SIZE]) const;
void Decode(const unsigned char code[BIP32_EXTKEY_SIZE]);
[[nodiscard]] bool Derive(CExtKey& out, unsigned int nChild) const;

View File

@ -277,6 +277,11 @@ static const CRPCConvertParam vRPCConvertParams[] =
{ "logging", 1, "exclude" },
{ "disconnectnode", 1, "nodeid" },
{ "upgradewallet", 0, "version" },
{ "gethdkeys", 0, "active_only" },
{ "gethdkeys", 0, "options" },
{ "gethdkeys", 0, "private" },
{ "createwalletdescriptor", 1, "options" },
{ "createwalletdescriptor", 1, "internal" },
// Echo with conversion (For testing only)
{ "echojson", 0, "arg0" },
{ "echojson", 1, "arg1" },

View File

@ -212,6 +212,11 @@ public:
/** Derive a private key, if private data is available in arg. */
virtual bool GetPrivKey(int pos, const SigningProvider& arg, CKey& key) const = 0;
/** Return the non-extended public key for this PubkeyProvider, if it has one. */
virtual std::optional<CPubKey> GetRootPubKey() const = 0;
/** Return the extended public key for this PubkeyProvider, if it has one. */
virtual std::optional<CExtPubKey> GetRootExtPubKey() const = 0;
};
class OriginPubkeyProvider final : public PubkeyProvider
@ -265,6 +270,14 @@ public:
{
return m_provider->GetPrivKey(pos, arg, key);
}
std::optional<CPubKey> GetRootPubKey() const override
{
return m_provider->GetRootPubKey();
}
std::optional<CExtPubKey> GetRootExtPubKey() const override
{
return m_provider->GetRootExtPubKey();
}
};
/** An object representing a parsed constant public key in a descriptor. */
@ -310,6 +323,14 @@ public:
{
return arg.GetKey(m_pubkey.GetID(), key);
}
std::optional<CPubKey> GetRootPubKey() const override
{
return m_pubkey;
}
std::optional<CExtPubKey> GetRootExtPubKey() const override
{
return std::nullopt;
}
};
enum class DeriveType {
@ -525,6 +546,14 @@ public:
key = extkey.key;
return true;
}
std::optional<CPubKey> GetRootPubKey() const override
{
return std::nullopt;
}
std::optional<CExtPubKey> GetRootExtPubKey() const override
{
return m_root_extkey;
}
};
/** Base class for all Descriptor implementations. */
@ -720,6 +749,19 @@ public:
std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override
{
for (const auto& p : m_pubkey_args) {
std::optional<CPubKey> pub = p->GetRootPubKey();
if (pub) pubkeys.insert(*pub);
std::optional<CExtPubKey> ext_pub = p->GetRootExtPubKey();
if (ext_pub) ext_pubs.insert(*ext_pub);
}
for (const auto& arg : m_subdescriptor_args) {
arg->GetPubKeys(pubkeys, ext_pubs);
}
}
};
/** A parsed addr(A) descriptor. */

View File

@ -158,6 +158,13 @@ struct Descriptor {
/** Get the maximum size number of stack elements for satisfying this descriptor. */
virtual std::optional<int64_t> MaxSatisfactionElems() const = 0;
/** Return all (extended) public keys for this descriptor, including any from subdescriptors.
*
* @param[out] pubkeys Any public keys
* @param[out] ext_pubs Any extended public keys
*/
virtual void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const = 0;
};
/** Parse a `descriptor` string. Included private keys are put in `out`.

View File

@ -817,6 +817,217 @@ static RPCHelpMan migratewallet()
};
}
RPCHelpMan gethdkeys()
{
return RPCHelpMan{
"gethdkeys",
"\nList all BIP 32 HD keys in the wallet and which descriptors use them.\n",
{
{"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "", {
{"active_only", RPCArg::Type::BOOL, RPCArg::Default{false}, "Show the keys for only active descriptors"},
{"private", RPCArg::Type::BOOL, RPCArg::Default{false}, "Show private keys"}
}},
},
RPCResult{RPCResult::Type::ARR, "", "", {
{
{RPCResult::Type::OBJ, "", "", {
{RPCResult::Type::STR, "xpub", "The extended public key"},
{RPCResult::Type::BOOL, "has_private", "Whether the wallet has the private key for this xpub"},
{RPCResult::Type::STR, "xprv", /*optional=*/true, "The extended private key if \"private\" is true"},
{RPCResult::Type::ARR, "descriptors", "Array of descriptor objects that use this HD key",
{
{RPCResult::Type::OBJ, "", "", {
{RPCResult::Type::STR, "desc", "Descriptor string representation"},
{RPCResult::Type::BOOL, "active", "Whether this descriptor is currently used to generate new addresses"},
}},
}},
}},
}
}},
RPCExamples{
HelpExampleCli("gethdkeys", "") + HelpExampleRpc("gethdkeys", "")
+ HelpExampleCliNamed("gethdkeys", {{"active_only", "true"}, {"private", "true"}}) + HelpExampleRpcNamed("gethdkeys", {{"active_only", "true"}, {"private", "true"}})
},
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
{
const std::shared_ptr<const CWallet> wallet = GetWalletForJSONRPCRequest(request);
if (!wallet) return UniValue::VNULL;
if (!wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
throw JSONRPCError(RPC_WALLET_ERROR, "gethdkeys is not available for non-descriptor wallets");
}
LOCK(wallet->cs_wallet);
UniValue options{request.params[0].isNull() ? UniValue::VOBJ : request.params[0]};
const bool active_only{options.exists("active_only") ? options["active_only"].get_bool() : false};
const bool priv{options.exists("private") ? options["private"].get_bool() : false};
if (priv) {
EnsureWalletIsUnlocked(*wallet);
}
std::set<ScriptPubKeyMan*> spkms;
if (active_only) {
spkms = wallet->GetActiveScriptPubKeyMans();
} else {
spkms = wallet->GetAllScriptPubKeyMans();
}
std::map<CExtPubKey, std::set<std::tuple<std::string, bool, bool>>> wallet_xpubs;
std::map<CExtPubKey, CExtKey> wallet_xprvs;
for (auto* spkm : spkms) {
auto* desc_spkm{dynamic_cast<DescriptorScriptPubKeyMan*>(spkm)};
CHECK_NONFATAL(desc_spkm);
LOCK(desc_spkm->cs_desc_man);
WalletDescriptor w_desc = desc_spkm->GetWalletDescriptor();
// Retrieve the pubkeys from the descriptor
std::set<CPubKey> desc_pubkeys;
std::set<CExtPubKey> desc_xpubs;
w_desc.descriptor->GetPubKeys(desc_pubkeys, desc_xpubs);
for (const CExtPubKey& xpub : desc_xpubs) {
std::string desc_str;
bool ok = desc_spkm->GetDescriptorString(desc_str, false);
CHECK_NONFATAL(ok);
wallet_xpubs[xpub].emplace(desc_str, wallet->IsActiveScriptPubKeyMan(*spkm), desc_spkm->HasPrivKey(xpub.pubkey.GetID()));
if (std::optional<CKey> key = priv ? desc_spkm->GetKey(xpub.pubkey.GetID()) : std::nullopt) {
wallet_xprvs[xpub] = CExtKey(xpub, *key);
}
}
}
UniValue response(UniValue::VARR);
for (const auto& [xpub, descs] : wallet_xpubs) {
bool has_xprv = false;
UniValue descriptors(UniValue::VARR);
for (const auto& [desc, active, has_priv] : descs) {
UniValue d(UniValue::VOBJ);
d.pushKV("desc", desc);
d.pushKV("active", active);
has_xprv |= has_priv;
descriptors.push_back(std::move(d));
}
UniValue xpub_info(UniValue::VOBJ);
xpub_info.pushKV("xpub", EncodeExtPubKey(xpub));
xpub_info.pushKV("has_private", has_xprv);
if (priv) {
xpub_info.pushKV("xprv", EncodeExtKey(wallet_xprvs.at(xpub)));
}
xpub_info.pushKV("descriptors", std::move(descriptors));
response.push_back(std::move(xpub_info));
}
return response;
},
};
}
static RPCHelpMan createwalletdescriptor()
{
return RPCHelpMan{"createwalletdescriptor",
"Creates the wallet's descriptor for the given address type. "
"The address type must be one that the wallet does not already have a descriptor for."
+ HELP_REQUIRING_PASSPHRASE,
{
{"type", RPCArg::Type::STR, RPCArg::Optional::NO, "The address type the descriptor will produce. Options are \"legacy\", \"p2sh-segwit\", \"bech32\", and \"bech32m\"."},
{"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "", {
{"internal", RPCArg::Type::BOOL, RPCArg::DefaultHint{"Both external and internal will be generated unless this parameter is specified"}, "Whether to only make one descriptor that is internal (if parameter is true) or external (if parameter is false)"},
{"hdkey", RPCArg::Type::STR, RPCArg::DefaultHint{"The HD key used by all other active descriptors"}, "The HD key that the wallet knows the private key of, listed using 'gethdkeys', to use for this descriptor's key"},
}},
},
RPCResult{
RPCResult::Type::OBJ, "", "",
{
{RPCResult::Type::ARR, "descs", "The public descriptors that were added to the wallet",
{{RPCResult::Type::STR, "", ""}}
}
},
},
RPCExamples{
HelpExampleCli("createwalletdescriptor", "bech32m")
+ HelpExampleRpc("createwalletdescriptor", "bech32m")
},
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
{
std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
if (!pwallet) return UniValue::VNULL;
// Make sure wallet is a descriptor wallet
if (!pwallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
throw JSONRPCError(RPC_WALLET_ERROR, "createwalletdescriptor is not available for non-descriptor wallets");
}
std::optional<OutputType> output_type = ParseOutputType(request.params[0].get_str());
if (!output_type) {
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Unknown address type '%s'", request.params[0].get_str()));
}
UniValue options{request.params[1].isNull() ? UniValue::VOBJ : request.params[1]};
UniValue internal_only{options["internal"]};
UniValue hdkey{options["hdkey"]};
std::vector<bool> internals;
if (internal_only.isNull()) {
internals.push_back(false);
internals.push_back(true);
} else {
internals.push_back(internal_only.get_bool());
}
LOCK(pwallet->cs_wallet);
EnsureWalletIsUnlocked(*pwallet);
CExtPubKey xpub;
if (hdkey.isNull()) {
std::set<CExtPubKey> active_xpubs = pwallet->GetActiveHDPubKeys();
if (active_xpubs.size() != 1) {
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Unable to determine which HD key to use from active descriptors. Please specify with 'hdkey'");
}
xpub = *active_xpubs.begin();
} else {
xpub = DecodeExtPubKey(hdkey.get_str());
if (!xpub.pubkey.IsValid()) {
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Unable to parse HD key. Please provide a valid xpub");
}
}
std::optional<CKey> key = pwallet->GetKey(xpub.pubkey.GetID());
if (!key) {
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Private key for %s is not known", EncodeExtPubKey(xpub)));
}
CExtKey active_hdkey(xpub, *key);
std::vector<std::reference_wrapper<DescriptorScriptPubKeyMan>> spkms;
WalletBatch batch{pwallet->GetDatabase()};
for (bool internal : internals) {
WalletDescriptor w_desc = GenerateWalletDescriptor(xpub, *output_type, internal);
uint256 w_id = DescriptorID(*w_desc.descriptor);
if (!pwallet->GetScriptPubKeyMan(w_id)) {
spkms.emplace_back(pwallet->SetupDescriptorScriptPubKeyMan(batch, active_hdkey, *output_type, internal));
}
}
if (spkms.empty()) {
throw JSONRPCError(RPC_WALLET_ERROR, "Descriptor already exists");
}
// Fetch each descspkm from the wallet in order to get the descriptor strings
UniValue descs{UniValue::VARR};
for (const auto& spkm : spkms) {
std::string desc_str;
bool ok = spkm.get().GetDescriptorString(desc_str, false);
CHECK_NONFATAL(ok);
descs.push_back(desc_str);
}
UniValue out{UniValue::VOBJ};
out.pushKV("descs", std::move(descs));
return out;
}
};
}
// addresses
RPCHelpMan getaddressinfo();
RPCHelpMan getnewaddress();
@ -900,6 +1111,7 @@ Span<const CRPCCommand> GetWalletRPCCommands()
{"wallet", &bumpfee},
{"wallet", &psbtbumpfee},
{"wallet", &createwallet},
{"wallet", &createwalletdescriptor},
{"wallet", &restorewallet},
{"wallet", &dumpprivkey},
{"wallet", &dumpwallet},
@ -907,6 +1119,7 @@ Span<const CRPCCommand> GetWalletRPCCommands()
{"wallet", &getaddressesbylabel},
{"wallet", &getaddressinfo},
{"wallet", &getbalance},
{"wallet", &gethdkeys},
{"wallet", &getnewaddress},
{"wallet", &getrawchangeaddress},
{"wallet", &getreceivedbyaddress},

View File

@ -11,6 +11,7 @@
#include <script/sign.h>
#include <script/solver.h>
#include <util/bip32.h>
#include <util/check.h>
#include <util/strencodings.h>
#include <util/string.h>
#include <util/time.h>
@ -2143,6 +2144,36 @@ std::map<CKeyID, CKey> DescriptorScriptPubKeyMan::GetKeys() const
return m_map_keys;
}
bool DescriptorScriptPubKeyMan::HasPrivKey(const CKeyID& keyid) const
{
AssertLockHeld(cs_desc_man);
return m_map_keys.contains(keyid) || m_map_crypted_keys.contains(keyid);
}
std::optional<CKey> DescriptorScriptPubKeyMan::GetKey(const CKeyID& keyid) const
{
AssertLockHeld(cs_desc_man);
if (m_storage.HasEncryptionKeys() && !m_storage.IsLocked()) {
const auto& it = m_map_crypted_keys.find(keyid);
if (it == m_map_crypted_keys.end()) {
return std::nullopt;
}
const std::vector<unsigned char>& crypted_secret = it->second.second;
CKey key;
if (!Assume(m_storage.WithEncryptionKey([&](const CKeyingMaterial& encryption_key) {
return DecryptKey(encryption_key, crypted_secret, it->second.first, key);
}))) {
return std::nullopt;
}
return key;
}
const auto& it = m_map_keys.find(keyid);
if (it == m_map_keys.end()) {
return std::nullopt;
}
return it->second;
}
bool DescriptorScriptPubKeyMan::TopUp(unsigned int size)
{
WalletBatch batch(m_storage.GetDatabase());
@ -2296,55 +2327,7 @@ bool DescriptorScriptPubKeyMan::SetupDescriptorGeneration(WalletBatch& batch, co
return false;
}
int64_t creation_time = GetTime();
std::string xpub = EncodeExtPubKey(master_key.Neuter());
// Build descriptor string
std::string desc_prefix;
std::string desc_suffix = "/*)";
switch (addr_type) {
case OutputType::LEGACY: {
desc_prefix = "pkh(" + xpub + "/44h";
break;
}
case OutputType::P2SH_SEGWIT: {
desc_prefix = "sh(wpkh(" + xpub + "/49h";
desc_suffix += ")";
break;
}
case OutputType::BECH32: {
desc_prefix = "wpkh(" + xpub + "/84h";
break;
}
case OutputType::BECH32M: {
desc_prefix = "tr(" + xpub + "/86h";
break;
}
case OutputType::UNKNOWN: {
// We should never have a DescriptorScriptPubKeyMan for an UNKNOWN OutputType,
// so if we get to this point something is wrong
assert(false);
}
} // no default case, so the compiler can warn about missing cases
assert(!desc_prefix.empty());
// Mainnet derives at 0', testnet and regtest derive at 1'
if (Params().IsTestChain()) {
desc_prefix += "/1h";
} else {
desc_prefix += "/0h";
}
std::string internal_path = internal ? "/1" : "/0";
std::string desc_str = desc_prefix + "/0h" + internal_path + desc_suffix;
// Make the descriptor
FlatSigningProvider keys;
std::string error;
std::unique_ptr<Descriptor> desc = Parse(desc_str, keys, error, false);
WalletDescriptor w_desc(std::move(desc), creation_time, 0, 0, 0);
m_wallet_descriptor = w_desc;
m_wallet_descriptor = GenerateWalletDescriptor(master_key.Neuter(), addr_type, internal);
// Store the master private key, and descriptor
if (!AddDescriptorKeyWithDB(batch, master_key.key, master_key.key.GetPubKey())) {

View File

@ -633,6 +633,9 @@ public:
bool SetupDescriptorGeneration(WalletBatch& batch, const CExtKey& master_key, OutputType addr_type, bool internal);
bool HavePrivateKeys() const override;
bool HasPrivKey(const CKeyID& keyid) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
//! Retrieve the particular key if it is available. Returns nullopt if the key is not in the wallet, or if the wallet is locked.
std::optional<CKey> GetKey(const CKeyID& keyid) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
std::optional<int64_t> GetOldestKeyPoolTime() const override;
unsigned int GetKeyPoolSize() const override;
@ -669,7 +672,7 @@ public:
std::unordered_set<CScript, SaltedSipHasher> GetScriptPubKeys(int32_t minimum_index) const;
int32_t GetEndRange() const;
bool GetDescriptorString(std::string& out, const bool priv) const;
[[nodiscard]] bool GetDescriptorString(std::string& out, const bool priv) const;
void UpgradeDescriptorCache();
};

View File

@ -34,6 +34,7 @@ public:
std::optional<int64_t> ScriptSize() const override { return {}; }
std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override {}
};
BOOST_FIXTURE_TEST_CASE(wallet_load_descriptors, TestingSetup)

View File

@ -3497,6 +3497,17 @@ std::set<ScriptPubKeyMan*> CWallet::GetActiveScriptPubKeyMans() const
return spk_mans;
}
bool CWallet::IsActiveScriptPubKeyMan(const ScriptPubKeyMan& spkm) const
{
for (const auto& [_, ext_spkm] : m_external_spk_managers) {
if (ext_spkm == &spkm) return true;
}
for (const auto& [_, int_spkm] : m_internal_spk_managers) {
if (int_spkm == &spkm) return true;
}
return false;
}
std::set<ScriptPubKeyMan*> CWallet::GetAllScriptPubKeyMans() const
{
std::set<ScriptPubKeyMan*> spk_mans;
@ -3651,6 +3662,26 @@ DescriptorScriptPubKeyMan& CWallet::LoadDescriptorScriptPubKeyMan(uint256 id, Wa
return *spk_manager;
}
DescriptorScriptPubKeyMan& CWallet::SetupDescriptorScriptPubKeyMan(WalletBatch& batch, const CExtKey& master_key, const OutputType& output_type, bool internal)
{
AssertLockHeld(cs_wallet);
auto spk_manager = std::unique_ptr<DescriptorScriptPubKeyMan>(new DescriptorScriptPubKeyMan(*this, m_keypool_size));
if (IsCrypted()) {
if (IsLocked()) {
throw std::runtime_error(std::string(__func__) + ": Wallet is locked, cannot setup new descriptors");
}
if (!spk_manager->CheckDecryptionKey(vMasterKey) && !spk_manager->Encrypt(vMasterKey, &batch)) {
throw std::runtime_error(std::string(__func__) + ": Could not encrypt new descriptors");
}
}
spk_manager->SetupDescriptorGeneration(batch, master_key, output_type, internal);
DescriptorScriptPubKeyMan* out = spk_manager.get();
uint256 id = spk_manager->GetID();
AddScriptPubKeyMan(id, std::move(spk_manager));
AddActiveScriptPubKeyManWithDb(batch, id, output_type, internal);
return *out;
}
void CWallet::SetupDescriptorScriptPubKeyMans(const CExtKey& master_key)
{
AssertLockHeld(cs_wallet);
@ -3661,19 +3692,7 @@ void CWallet::SetupDescriptorScriptPubKeyMans(const CExtKey& master_key)
for (bool internal : {false, true}) {
for (OutputType t : OUTPUT_TYPES) {
auto spk_manager = std::unique_ptr<DescriptorScriptPubKeyMan>(new DescriptorScriptPubKeyMan(*this, m_keypool_size));
if (IsCrypted()) {
if (IsLocked()) {
throw std::runtime_error(std::string(__func__) + ": Wallet is locked, cannot setup new descriptors");
}
if (!spk_manager->CheckDecryptionKey(vMasterKey) && !spk_manager->Encrypt(vMasterKey, &batch)) {
throw std::runtime_error(std::string(__func__) + ": Could not encrypt new descriptors");
}
}
spk_manager->SetupDescriptorGeneration(batch, master_key, t, internal);
uint256 id = spk_manager->GetID();
AddScriptPubKeyMan(id, std::move(spk_manager));
AddActiveScriptPubKeyManWithDb(batch, id, t, internal);
SetupDescriptorScriptPubKeyMan(batch, master_key, t, internal);
}
}
@ -4501,4 +4520,40 @@ void CWallet::TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm
// Update scriptPubKey cache
CacheNewScriptPubKeys(spks, spkm);
}
std::set<CExtPubKey> CWallet::GetActiveHDPubKeys() const
{
AssertLockHeld(cs_wallet);
Assert(IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
std::set<CExtPubKey> active_xpubs;
for (const auto& spkm : GetActiveScriptPubKeyMans()) {
const DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
assert(desc_spkm);
LOCK(desc_spkm->cs_desc_man);
WalletDescriptor w_desc = desc_spkm->GetWalletDescriptor();
std::set<CPubKey> desc_pubkeys;
std::set<CExtPubKey> desc_xpubs;
w_desc.descriptor->GetPubKeys(desc_pubkeys, desc_xpubs);
active_xpubs.merge(std::move(desc_xpubs));
}
return active_xpubs;
}
std::optional<CKey> CWallet::GetKey(const CKeyID& keyid) const
{
Assert(IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
for (const auto& spkm : GetAllScriptPubKeyMans()) {
const DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
assert(desc_spkm);
LOCK(desc_spkm->cs_desc_man);
if (std::optional<CKey> key = desc_spkm->GetKey(keyid)) {
return key;
}
}
return std::nullopt;
}
} // namespace wallet

View File

@ -938,6 +938,7 @@ public:
//! Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers
std::set<ScriptPubKeyMan*> GetActiveScriptPubKeyMans() const;
bool IsActiveScriptPubKeyMan(const ScriptPubKeyMan& spkm) const;
//! Returns all unique ScriptPubKeyMans
std::set<ScriptPubKeyMan*> GetAllScriptPubKeyMans() const;
@ -1013,6 +1014,8 @@ public:
//! @param[in] internal Whether this ScriptPubKeyMan provides change addresses
void DeactivateScriptPubKeyMan(uint256 id, OutputType type, bool internal);
//! Create new DescriptorScriptPubKeyMan and add it to the wallet
DescriptorScriptPubKeyMan& SetupDescriptorScriptPubKeyMan(WalletBatch& batch, const CExtKey& master_key, const OutputType& output_type, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
//! Create new DescriptorScriptPubKeyMans and add them to the wallet
void SetupDescriptorScriptPubKeyMans(const CExtKey& master_key) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
void SetupDescriptorScriptPubKeyMans() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
@ -1049,6 +1052,13 @@ public:
void CacheNewScriptPubKeys(const std::set<CScript>& spks, ScriptPubKeyMan* spkm);
void TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm) override;
//! Retrieve the xpubs in use by the active descriptors
std::set<CExtPubKey> GetActiveHDPubKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
//! Find the private key for the given key id from the wallet's descriptors, if available
//! Returns nullopt when no descriptor has the key or if the wallet is locked.
std::optional<CKey> GetKey(const CKeyID& keyid) const;
};
/**

View File

@ -4,7 +4,9 @@
#include <wallet/walletutil.h>
#include <chainparams.h>
#include <common/args.h>
#include <key_io.h>
#include <logging.h>
namespace wallet {
@ -43,4 +45,58 @@ WalletFeature GetClosestWalletFeature(int version)
}
return static_cast<WalletFeature>(0);
}
WalletDescriptor GenerateWalletDescriptor(const CExtPubKey& master_key, const OutputType& addr_type, bool internal)
{
int64_t creation_time = GetTime();
std::string xpub = EncodeExtPubKey(master_key);
// Build descriptor string
std::string desc_prefix;
std::string desc_suffix = "/*)";
switch (addr_type) {
case OutputType::LEGACY: {
desc_prefix = "pkh(" + xpub + "/44h";
break;
}
case OutputType::P2SH_SEGWIT: {
desc_prefix = "sh(wpkh(" + xpub + "/49h";
desc_suffix += ")";
break;
}
case OutputType::BECH32: {
desc_prefix = "wpkh(" + xpub + "/84h";
break;
}
case OutputType::BECH32M: {
desc_prefix = "tr(" + xpub + "/86h";
break;
}
case OutputType::UNKNOWN: {
// We should never have a DescriptorScriptPubKeyMan for an UNKNOWN OutputType,
// so if we get to this point something is wrong
assert(false);
}
} // no default case, so the compiler can warn about missing cases
assert(!desc_prefix.empty());
// Mainnet derives at 0', testnet and regtest derive at 1'
if (Params().IsTestChain()) {
desc_prefix += "/1h";
} else {
desc_prefix += "/0h";
}
std::string internal_path = internal ? "/1" : "/0";
std::string desc_str = desc_prefix + "/0h" + internal_path + desc_suffix;
// Make the descriptor
FlatSigningProvider keys;
std::string error;
std::unique_ptr<Descriptor> desc = Parse(desc_str, keys, error, false);
WalletDescriptor w_desc(std::move(desc), creation_time, 0, 0, 0);
return w_desc;
}
} // namespace wallet

View File

@ -114,6 +114,8 @@ public:
WalletDescriptor() {}
WalletDescriptor(std::shared_ptr<Descriptor> descriptor, uint64_t creation_time, int32_t range_start, int32_t range_end, int32_t next_index) : descriptor(descriptor), id(DescriptorID(*descriptor)), creation_time(creation_time), range_start(range_start), range_end(range_end), next_index(next_index) { }
};
WalletDescriptor GenerateWalletDescriptor(const CExtPubKey& master_key, const OutputType& output_type, bool internal);
} // namespace wallet
#endif // BITCOIN_WALLET_WALLETUTIL_H

View File

@ -181,6 +181,8 @@ BASE_SCRIPTS = [
'wallet_keypool_topup.py --legacy-wallet',
'wallet_keypool_topup.py --descriptors',
'wallet_fast_rescan.py --descriptors',
'wallet_gethdkeys.py --descriptors',
'wallet_createwalletdescriptor.py --descriptors',
'interface_zmq.py',
'rpc_invalid_address_message.py',
'rpc_validateaddress.py',

View File

@ -355,6 +355,25 @@ class BackwardsCompatibilityTest(BitcoinTestFramework):
down_wallet_name = f"re_down_{node.version}"
down_backup_path = os.path.join(self.options.tmpdir, f"{down_wallet_name}.dat")
wallet.backupwallet(down_backup_path)
# Check that taproot descriptors can be added to 0.21 wallets
# This must be done after the backup is created so that 0.21 can still load
# the backup
if self.options.descriptors and self.major_version_equals(node, 21):
assert_raises_rpc_error(-12, "No bech32m addresses available", wallet.getnewaddress, address_type="bech32m")
xpubs = wallet.gethdkeys(active_only=True)
assert_equal(len(xpubs), 1)
assert_equal(len(xpubs[0]["descriptors"]), 6)
wallet.createwalletdescriptor("bech32m")
xpubs = wallet.gethdkeys(active_only=True)
assert_equal(len(xpubs), 1)
assert_equal(len(xpubs[0]["descriptors"]), 8)
tr_descs = [desc["desc"] for desc in xpubs[0]["descriptors"] if desc["desc"].startswith("tr(")]
assert_equal(len(tr_descs), 2)
for desc in tr_descs:
assert info["hdmasterfingerprint"] in desc
wallet.getnewaddress(address_type="bech32m")
wallet.unloadwallet()
# Check that no automatic upgrade broke the downgrading the wallet

View File

@ -0,0 +1,123 @@
#!/usr/bin/env python3
# Copyright (c) 2023 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""Test wallet createwalletdescriptor RPC."""
from test_framework.descriptors import descsum_create
from test_framework.test_framework import BitcoinTestFramework
from test_framework.util import (
assert_equal,
assert_raises_rpc_error,
)
from test_framework.wallet_util import WalletUnlock
class WalletCreateDescriptorTest(BitcoinTestFramework):
def add_options(self, parser):
self.add_wallet_options(parser, descriptors=True, legacy=False)
def set_test_params(self):
self.setup_clean_chain = True
self.num_nodes = 1
def skip_test_if_missing_module(self):
self.skip_if_no_wallet()
def run_test(self):
self.test_basic()
self.test_imported_other_keys()
self.test_encrypted()
def test_basic(self):
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
self.nodes[0].createwallet("blank", blank=True)
wallet = self.nodes[0].get_wallet_rpc("blank")
xpub_info = def_wallet.gethdkeys(private=True)
xpub = xpub_info[0]["xpub"]
xprv = xpub_info[0]["xprv"]
expected_descs = []
for desc in def_wallet.listdescriptors()["descriptors"]:
if desc["desc"].startswith("wpkh("):
expected_descs.append(desc["desc"])
assert_raises_rpc_error(-5, "Unable to determine which HD key to use from active descriptors. Please specify with 'hdkey'", wallet.createwalletdescriptor, "bech32")
assert_raises_rpc_error(-5, f"Private key for {xpub} is not known", wallet.createwalletdescriptor, type="bech32", hdkey=xpub)
self.log.info("Test createwalletdescriptor after importing active descriptor to blank wallet")
# Import one active descriptor
assert_equal(wallet.importdescriptors([{"desc": descsum_create(f"pkh({xprv}/44h/2h/0h/0/0/*)"), "timestamp": "now", "active": True}])[0]["success"], True)
assert_equal(len(wallet.listdescriptors()["descriptors"]), 1)
assert_equal(len(wallet.gethdkeys()), 1)
new_descs = wallet.createwalletdescriptor("bech32")["descs"]
assert_equal(len(new_descs), 2)
assert_equal(len(wallet.gethdkeys()), 1)
assert_equal(new_descs, expected_descs)
self.log.info("Test descriptor creation options")
old_descs = set([(d["desc"], d["active"], d["internal"]) for d in wallet.listdescriptors(private=True)["descriptors"]])
wallet.createwalletdescriptor(type="bech32m", internal=False)
curr_descs = set([(d["desc"], d["active"], d["internal"]) for d in wallet.listdescriptors(private=True)["descriptors"]])
new_descs = list(curr_descs - old_descs)
assert_equal(len(new_descs), 1)
assert_equal(len(wallet.gethdkeys()), 1)
assert_equal(new_descs[0][0], descsum_create(f"tr({xprv}/86h/1h/0h/0/*)"))
assert_equal(new_descs[0][1], True)
assert_equal(new_descs[0][2], False)
old_descs = curr_descs
wallet.createwalletdescriptor(type="bech32m", internal=True)
curr_descs = set([(d["desc"], d["active"], d["internal"]) for d in wallet.listdescriptors(private=True)["descriptors"]])
new_descs = list(curr_descs - old_descs)
assert_equal(len(new_descs), 1)
assert_equal(len(wallet.gethdkeys()), 1)
assert_equal(new_descs[0][0], descsum_create(f"tr({xprv}/86h/1h/0h/1/*)"))
assert_equal(new_descs[0][1], True)
assert_equal(new_descs[0][2], True)
def test_imported_other_keys(self):
self.log.info("Test createwalletdescriptor with multiple keys in active descriptors")
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
self.nodes[0].createwallet("multiple_keys")
wallet = self.nodes[0].get_wallet_rpc("multiple_keys")
wallet_xpub = wallet.gethdkeys()[0]["xpub"]
xpub_info = def_wallet.gethdkeys(private=True)
xpub = xpub_info[0]["xpub"]
xprv = xpub_info[0]["xprv"]
assert_equal(wallet.importdescriptors([{"desc": descsum_create(f"wpkh({xprv}/0/0/*)"), "timestamp": "now", "active": True}])[0]["success"], True)
assert_equal(len(wallet.gethdkeys()), 2)
assert_raises_rpc_error(-5, "Unable to determine which HD key to use from active descriptors. Please specify with 'hdkey'", wallet.createwalletdescriptor, "bech32")
assert_raises_rpc_error(-4, "Descriptor already exists", wallet.createwalletdescriptor, type="bech32m", hdkey=wallet_xpub)
assert_raises_rpc_error(-5, "Unable to parse HD key. Please provide a valid xpub", wallet.createwalletdescriptor, type="bech32m", hdkey=xprv)
# Able to replace tr() descriptor with other hd key
wallet.createwalletdescriptor(type="bech32m", hdkey=xpub)
def test_encrypted(self):
self.log.info("Test createwalletdescriptor with encrypted wallets")
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
self.nodes[0].createwallet("encrypted", blank=True, passphrase="pass")
wallet = self.nodes[0].get_wallet_rpc("encrypted")
xpub_info = def_wallet.gethdkeys(private=True)
xprv = xpub_info[0]["xprv"]
with WalletUnlock(wallet, "pass"):
assert_equal(wallet.importdescriptors([{"desc": descsum_create(f"wpkh({xprv}/0/0/*)"), "timestamp": "now", "active": True}])[0]["success"], True)
assert_equal(len(wallet.gethdkeys()), 1)
assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first.", wallet.createwalletdescriptor, type="bech32m")
with WalletUnlock(wallet, "pass"):
wallet.createwalletdescriptor(type="bech32m")
if __name__ == '__main__':
WalletCreateDescriptorTest().main()

View File

@ -0,0 +1,185 @@
#!/usr/bin/env python3
# Copyright (c) 2023 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""Test wallet gethdkeys RPC."""
from test_framework.descriptors import descsum_create
from test_framework.test_framework import BitcoinTestFramework
from test_framework.util import (
assert_equal,
assert_raises_rpc_error,
)
from test_framework.wallet_util import WalletUnlock
class WalletGetHDKeyTest(BitcoinTestFramework):
def add_options(self, parser):
self.add_wallet_options(parser, descriptors=True, legacy=False)
def set_test_params(self):
self.setup_clean_chain = True
self.num_nodes = 1
def skip_test_if_missing_module(self):
self.skip_if_no_wallet()
def run_test(self):
self.test_basic_gethdkeys()
self.test_ranged_imports()
self.test_lone_key_imports()
self.test_ranged_multisig()
self.test_mixed_multisig()
def test_basic_gethdkeys(self):
self.log.info("Test gethdkeys basics")
self.nodes[0].createwallet("basic")
wallet = self.nodes[0].get_wallet_rpc("basic")
xpub_info = wallet.gethdkeys()
assert_equal(len(xpub_info), 1)
assert_equal(xpub_info[0]["has_private"], True)
assert "xprv" not in xpub_info[0]
xpub = xpub_info[0]["xpub"]
xpub_info = wallet.gethdkeys(private=True)
xprv = xpub_info[0]["xprv"]
assert_equal(xpub_info[0]["xpub"], xpub)
assert_equal(xpub_info[0]["has_private"], True)
descs = wallet.listdescriptors(True)
for desc in descs["descriptors"]:
assert xprv in desc["desc"]
self.log.info("HD pubkey can be retrieved from encrypted wallets")
prev_xprv = xprv
wallet.encryptwallet("pass")
# HD key is rotated on encryption, there should now be 2 HD keys
assert_equal(len(wallet.gethdkeys()), 2)
# New key is active, should be able to get only that one and its descriptors
xpub_info = wallet.gethdkeys(active_only=True)
assert_equal(len(xpub_info), 1)
assert xpub_info[0]["xpub"] != xpub
assert "xprv" not in xpub_info[0]
assert_equal(xpub_info[0]["has_private"], True)
self.log.info("HD privkey can be retrieved from encrypted wallets")
assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first", wallet.gethdkeys, private=True)
with WalletUnlock(wallet, "pass"):
xpub_info = wallet.gethdkeys(active_only=True, private=True)[0]
assert xpub_info["xprv"] != xprv
for desc in wallet.listdescriptors(True)["descriptors"]:
if desc["active"]:
# After encrypting, HD key was rotated and should appear in all active descriptors
assert xpub_info["xprv"] in desc["desc"]
else:
# Inactive descriptors should have the previous HD key
assert prev_xprv in desc["desc"]
def test_ranged_imports(self):
self.log.info("Keys of imported ranged descriptors appear in gethdkeys")
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
self.nodes[0].createwallet("imports")
wallet = self.nodes[0].get_wallet_rpc("imports")
xpub_info = wallet.gethdkeys()
assert_equal(len(xpub_info), 1)
active_xpub = xpub_info[0]["xpub"]
import_xpub = def_wallet.gethdkeys(active_only=True)[0]["xpub"]
desc_import = def_wallet.listdescriptors(True)["descriptors"]
for desc in desc_import:
desc["active"] = False
wallet.importdescriptors(desc_import)
assert_equal(wallet.gethdkeys(active_only=True), xpub_info)
xpub_info = wallet.gethdkeys()
assert_equal(len(xpub_info), 2)
for x in xpub_info:
if x["xpub"] == active_xpub:
for desc in x["descriptors"]:
assert_equal(desc["active"], True)
elif x["xpub"] == import_xpub:
for desc in x["descriptors"]:
assert_equal(desc["active"], False)
else:
assert False
def test_lone_key_imports(self):
self.log.info("Non-HD keys do not appear in gethdkeys")
self.nodes[0].createwallet("lonekey", blank=True)
wallet = self.nodes[0].get_wallet_rpc("lonekey")
assert_equal(wallet.gethdkeys(), [])
wallet.importdescriptors([{"desc": descsum_create("wpkh(cTe1f5rdT8A8DFgVWTjyPwACsDPJM9ff4QngFxUixCSvvbg1x6sh)"), "timestamp": "now"}])
assert_equal(wallet.gethdkeys(), [])
self.log.info("HD keys of non-ranged descriptors should appear in gethdkeys")
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
xpub_info = def_wallet.gethdkeys(private=True)
xpub = xpub_info[0]["xpub"]
xprv = xpub_info[0]["xprv"]
prv_desc = descsum_create(f"wpkh({xprv})")
pub_desc = descsum_create(f"wpkh({xpub})")
assert_equal(wallet.importdescriptors([{"desc": prv_desc, "timestamp": "now"}])[0]["success"], True)
xpub_info = wallet.gethdkeys()
assert_equal(len(xpub_info), 1)
assert_equal(xpub_info[0]["xpub"], xpub)
assert_equal(len(xpub_info[0]["descriptors"]), 1)
assert_equal(xpub_info[0]["descriptors"][0]["desc"], pub_desc)
assert_equal(xpub_info[0]["descriptors"][0]["active"], False)
def test_ranged_multisig(self):
self.log.info("HD keys of a multisig appear in gethdkeys")
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
self.nodes[0].createwallet("ranged_multisig")
wallet = self.nodes[0].get_wallet_rpc("ranged_multisig")
xpub1 = wallet.gethdkeys()[0]["xpub"]
xprv1 = wallet.gethdkeys(private=True)[0]["xprv"]
xpub2 = def_wallet.gethdkeys()[0]["xpub"]
prv_multi_desc = descsum_create(f"wsh(multi(2,{xprv1}/*,{xpub2}/*))")
pub_multi_desc = descsum_create(f"wsh(multi(2,{xpub1}/*,{xpub2}/*))")
assert_equal(wallet.importdescriptors([{"desc": prv_multi_desc, "timestamp": "now"}])[0]["success"], True)
xpub_info = wallet.gethdkeys()
assert_equal(len(xpub_info), 2)
for x in xpub_info:
if x["xpub"] == xpub1:
found_desc = next((d for d in xpub_info[0]["descriptors"] if d["desc"] == pub_multi_desc), None)
assert found_desc is not None
assert_equal(found_desc["active"], False)
elif x["xpub"] == xpub2:
assert_equal(len(x["descriptors"]), 1)
assert_equal(x["descriptors"][0]["desc"], pub_multi_desc)
assert_equal(x["descriptors"][0]["active"], False)
else:
assert False
def test_mixed_multisig(self):
self.log.info("Non-HD keys of a multisig do not appear in gethdkeys")
def_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
self.nodes[0].createwallet("single_multisig")
wallet = self.nodes[0].get_wallet_rpc("single_multisig")
xpub = wallet.gethdkeys()[0]["xpub"]
xprv = wallet.gethdkeys(private=True)[0]["xprv"]
pub = def_wallet.getaddressinfo(def_wallet.getnewaddress())["pubkey"]
prv_multi_desc = descsum_create(f"wsh(multi(2,{xprv},{pub}))")
pub_multi_desc = descsum_create(f"wsh(multi(2,{xpub},{pub}))")
import_res = wallet.importdescriptors([{"desc": prv_multi_desc, "timestamp": "now"}])
assert_equal(import_res[0]["success"], True)
xpub_info = wallet.gethdkeys()
assert_equal(len(xpub_info), 1)
assert_equal(xpub_info[0]["xpub"], xpub)
found_desc = next((d for d in xpub_info[0]["descriptors"] if d["desc"] == pub_multi_desc), None)
assert found_desc is not None
assert_equal(found_desc["active"], False)
if __name__ == '__main__':
WalletGetHDKeyTest().main()