highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-09-12 05:32:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

wallet: generalize GetActiveHDPubKeys helper

Browse Source 
GetHDPubKeys() centralizes the descriptor xpub lookup used by gethdkeys and
createwalletdescriptor, and by the derivehdkey RPC added in a later commit.
The HDKeyFilter argument serves gethdkeys' active_only mode (Active vs All)
and createwalletdescriptor's active descriptor selection.

No behavior change, except the dynamic_cast now uses Assert() instead of
gethdkeys' CHECK_NONFATAL, since it is not a recoverable input.
This commit is contained in:
Sjors Provoost
2026-06-26 15:54:11 +02:00
parent 3821452c4a
commit aaf1548475
3 changed files with 25 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/wallet/rpc/wallet.cpp
View File

@@ -27,6 +27,9 @@
namespace wallet {
using HDPubKeyMap = CWallet::HDPubKeyMap;
using HDKeyFilter = CWallet::HDKeyFilter;
static const std::map<uint64_t, std::string> WALLET_FLAG_CAVEATS{
{WALLET_FLAG_AVOID_REUSE,
"You need to rescan the blockchain in order to correctly mark used "
@@ -689,31 +692,15 @@ RPCMethod gethdkeys()
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) {
for (const auto& [xpub, spkms] : wallet->GetHDPubKeys(active_only ? HDKeyFilter::Active : HDKeyFilter::All)) {
for (auto* desc_spkm : spkms) {
LOCK(desc_spkm->cs_desc_man);
std::string desc_str;
bool ok = desc_spkm->GetDescriptorString(desc_str, /*priv=*/false);
CHECK_NONFATAL(ok);
wallet_xpubs[xpub].emplace(desc_str, wallet->IsActiveScriptPubKeyMan(*spkm), desc_spkm->HasPrivKey(xpub.pubkey.GetID()));
wallet_xpubs[xpub].emplace(desc_str, wallet->IsActiveScriptPubKeyMan(*desc_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);
}
@@ -800,11 +787,11 @@ static RPCMethod createwalletdescriptor()
CExtPubKey xpub;
if (hdkey.isNull()) {
std::set<CExtPubKey> active_xpubs = pwallet->GetActiveHDPubKeys();
HDPubKeyMap active_xpubs = pwallet->GetHDPubKeys(HDKeyFilter::Active);
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();
xpub = active_xpubs.begin()->first;
} else {
xpub = DecodeExtPubKey(hdkey.get_str());
if (!xpub.pubkey.IsValid()) {

15
src/wallet/wallet.cpp
View File

@@ -4535,25 +4535,26 @@ void CWallet::TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm
CacheNewScriptPubKeys(spks, spkm);
}
std::set<CExtPubKey> CWallet::GetActiveHDPubKeys() const
CWallet::HDPubKeyMap CWallet::GetHDPubKeys(HDKeyFilter filter) 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);
HDPubKeyMap xpubs;
for (const auto& spkm : filter == HDKeyFilter::Active ? GetActiveScriptPubKeyMans() : GetAllScriptPubKeyMans()) {
auto* desc_spkm = Assert(dynamic_cast<DescriptorScriptPubKeyMan*>(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));
for (const CExtPubKey& xpub : desc_xpubs) {
xpubs[xpub].insert(desc_spkm);
}
}
return active_xpubs;
return xpubs;
}
std::optional<CKey> CWallet::GetKey(const CKeyID& keyid) const

10
src/wallet/wallet.h
View File

@@ -1078,8 +1078,14 @@ public:
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);
//! Which descriptors GetHDPubKeys() should consider.
enum class HDKeyFilter {
Active, //!< Only active descriptors
All, //!< All descriptors
};
using HDPubKeyMap = std::map<CExtPubKey, std::set<DescriptorScriptPubKeyMan*>>;
//! Retrieve descriptor xpubs matching the requested filter.
HDPubKeyMap GetHDPubKeys(HDKeyFilter filter) 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.