Merge bitcoin/bitcoin#32624: fuzz: wallet: add target for MigrateToDescriptor

779e7825db fuzz: wallet: add target for `MigrateToDescriptor` (brunoerg)

Pull request description:

  This PR adds fuzz coverage for the scriptpubkeyman migration (`MigrateToDescriptor`). Note that it's a test for the migration of the scriptpubkey manager, not for the whole migration process as tried in #29694, because:
  1) The wallet migration deals with DBs which is expensive for fuzzing (was getting around 3 exec/s);
  2) Mocking would require lots of refactors.

  This target loads keys, HDChain (even inactive ones), watch only and might add tons of different scripts, then calls `MigrateToDescriptor`. It does not play with encrypted stuff because it would make the target super slow. Also, after the migration there are some assertions that would work as a regression test for https://github.com/bitcoin/bitcoin/pull/31452, for example.

ACKs for top commit:
  frankomosh:
    Code Review ACK 779e7825db
  marcofleon:
    reACK 779e7825db

Tree-SHA512: 08ef5166602c21658765bc063c5421e81055d094d346c4e2a28215209c6b7768b99a424f3ba47cf718dc8d827a588da22394ba23402a40a71a976d80d65e6c2e
This commit is contained in:
merge-script
2026-03-19 13:40:32 +01:00

View File

@@ -22,7 +22,9 @@
#include <util/check.h>
#include <util/time.h>
#include <util/translation.h>
#include <util/string.h>
#include <validation.h>
#include <wallet/context.h>
#include <wallet/scriptpubkeyman.h>
#include <wallet/test/util.h>
#include <wallet/types.h>
@@ -47,10 +49,15 @@ void initialize_spkm()
{
static const auto testing_setup{MakeNoLogFileContext<const TestingSetup>()};
g_setup = testing_setup.get();
SelectParams(ChainType::MAIN);
MOCKED_DESC_CONVERTER.Init();
}
void initialize_spkm_migration()
{
static const auto testing_setup{MakeNoLogFileContext<const TestingSetup>()};
g_setup = testing_setup.get();
}
static std::optional<std::pair<WalletDescriptor, FlatSigningProvider>> CreateWalletDescriptor(FuzzedDataProvider& fuzzed_data_provider)
{
const std::string mocked_descriptor{fuzzed_data_provider.ConsumeRandomLengthString()};
@@ -194,5 +201,141 @@ FUZZ_TARGET(scriptpubkeyman, .init = initialize_spkm)
(void)spk_manager->GetKeyPoolSize();
}
FUZZ_TARGET(spkm_migration, .init = initialize_spkm_migration)
{
SeedRandomStateForTest(SeedRand::ZEROS);
FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
SetMockTime(ConsumeTime(fuzzed_data_provider));
const auto& node{g_setup->m_node};
Chainstate& chainstate{node.chainman->ActiveChainstate()};
std::unique_ptr<CWallet> wallet_ptr{std::make_unique<CWallet>(node.chain.get(), "", CreateMockableWalletDatabase())};
CWallet& wallet{*wallet_ptr};
wallet.m_keypool_size = 1;
{
LOCK(wallet.cs_wallet);
wallet.UnsetWalletFlag(WALLET_FLAG_DESCRIPTORS);
wallet.SetLastBlockProcessed(chainstate.m_chain.Height(), chainstate.m_chain.Tip()->GetBlockHash());
}
auto& legacy_data{*wallet.GetOrCreateLegacyDataSPKM()};
std::vector<CKey> keys;
LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), 30) {
const auto key{ConsumePrivateKey(fuzzed_data_provider)};
if (!key.IsValid()) return;
auto pub_key{key.GetPubKey()};
if (!pub_key.IsFullyValid()) return;
if (legacy_data.LoadKey(key, pub_key) && std::find(keys.begin(), keys.end(), key) == keys.end()) keys.push_back(key);
}
bool add_hd_chain{fuzzed_data_provider.ConsumeBool() && !keys.empty()};
CHDChain hd_chain;
auto version{fuzzed_data_provider.ConsumeBool() ? CHDChain::VERSION_HD_CHAIN_SPLIT : CHDChain::VERSION_HD_BASE};
CKey hd_key;
if (add_hd_chain) {
hd_key = PickValue(fuzzed_data_provider, keys);
hd_chain.nVersion = version;
hd_chain.seed_id = hd_key.GetPubKey().GetID();
legacy_data.LoadHDChain(hd_chain);
}
bool add_inactive_hd_chain{fuzzed_data_provider.ConsumeBool() && !keys.empty()};
if (add_inactive_hd_chain) {
hd_key = PickValue(fuzzed_data_provider, keys);
hd_chain.nVersion = fuzzed_data_provider.ConsumeBool() ? CHDChain::VERSION_HD_CHAIN_SPLIT : CHDChain::VERSION_HD_BASE;
hd_chain.seed_id = hd_key.GetPubKey().GetID();
legacy_data.AddInactiveHDChain(hd_chain);
}
bool watch_only = false;
const auto pub_key = ConsumeDeserializable<CPubKey>(fuzzed_data_provider);
if (!pub_key || !pub_key->IsFullyValid()) return;
auto script_dest{GetScriptForDestination(WitnessV0KeyHash{*pub_key})};
if (fuzzed_data_provider.ConsumeBool()) {
script_dest = GetScriptForDestination(CTxDestination{PKHash(*pub_key)});
}
if (legacy_data.LoadWatchOnly(script_dest)) watch_only = true;
size_t added_script{0};
bool good_data{true};
LIMITED_WHILE(good_data && fuzzed_data_provider.ConsumeBool(), 30) {
CallOneOf(
fuzzed_data_provider,
[&] {
CKey key;
if (!keys.empty()) {
key = PickValue(fuzzed_data_provider, keys);
} else {
key = ConsumePrivateKey(fuzzed_data_provider, /*compressed=*/fuzzed_data_provider.ConsumeBool());
}
if (!key.IsValid()) return;
auto pub_key{key.GetPubKey()};
CScript script;
CallOneOf(
fuzzed_data_provider,
[&] {
script = GetScriptForDestination(CTxDestination{PKHash(pub_key)});
},
[&] {
script = GetScriptForDestination(WitnessV0KeyHash(pub_key));
},
[&] {
std::optional<CScript> script_opt{ConsumeDeserializable<CScript>(fuzzed_data_provider)};
if (!script_opt) {
good_data = false;
return;
}
script = script_opt.value();
}
);
if (fuzzed_data_provider.ConsumeBool()) script = GetScriptForDestination(ScriptHash(script));
if (!legacy_data.HaveCScript(CScriptID(script)) && legacy_data.AddCScript(script)) added_script++;
},
[&] {
CKey key;
if (!keys.empty()) {
key = PickValue(fuzzed_data_provider, keys);
} else {
key = ConsumePrivateKey(fuzzed_data_provider, /*compressed=*/fuzzed_data_provider.ConsumeBool());
}
if (!key.IsValid()) return;
const auto num_keys{fuzzed_data_provider.ConsumeIntegralInRange<size_t>(1, MAX_PUBKEYS_PER_MULTISIG)};
std::vector<CPubKey> pubkeys;
pubkeys.emplace_back(key.GetPubKey());
for (size_t i = 1; i < num_keys; i++) {
if (fuzzed_data_provider.ConsumeBool()) {
pubkeys.emplace_back(key.GetPubKey());
} else {
CKey private_key{ConsumePrivateKey(fuzzed_data_provider, /*compressed=*/fuzzed_data_provider.ConsumeBool())};
if (!private_key.IsValid()) return;
pubkeys.emplace_back(private_key.GetPubKey());
}
}
if (pubkeys.size() < num_keys) return;
CScript multisig_script{GetScriptForMultisig(num_keys, pubkeys)};
if (!legacy_data.HaveCScript(CScriptID(multisig_script)) && legacy_data.AddCScript(multisig_script)) {
added_script++;
}
}
);
}
auto result{legacy_data.MigrateToDescriptor()};
assert(result);
size_t added_chains{static_cast<size_t>(add_hd_chain) + static_cast<size_t>(add_inactive_hd_chain)};
if ((add_hd_chain && version >= CHDChain::VERSION_HD_CHAIN_SPLIT) || (!add_hd_chain && add_inactive_hd_chain)) {
added_chains *= 2;
}
size_t added_size{keys.size() + added_chains};
if (added_script > 0) {
assert(result->desc_spkms.size() >= added_size);
} else {
assert(result->desc_spkms.size() == added_size);
}
if (watch_only) assert(!result->watch_descs.empty());
if (!result->solvable_descs.empty()) assert(added_script > 0);
}
} // namespace
} // namespace wallet