test: cover ScriptPubKeyMan::IsKeyActive() and Wallet::IsDestinationActive()

Github-Pull: bitcoin#27216
Rebased-From: ba65d93

Author: pinheadmz

src/wallet/test/scriptpubkeyman_tests.cpp

@@ -40,5 +40,159 @@ BOOST_AUTO_TEST_CASE(CanProvide)
     BOOST_CHECK(keyman.CanProvide(p2sh_script, data));
 }
 
+BOOST_AUTO_TEST_CASE(Legacy_IsKeyActive)
+{
+    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
+    {
+        LOCK(wallet.cs_wallet);
+        wallet.SetMinVersion(FEATURE_LATEST);
+        wallet.m_keypool_size = 10;
+    }
+    LegacyScriptPubKeyMan& spkm = *wallet.GetOrCreateLegacyScriptPubKeyMan();
+
+    // Start off empty
+    BOOST_CHECK(spkm.GetScriptPubKeys().empty());
+
+    // Generate 20 keypool keys (10 internal, 10 external)
+    {
+        LOCK(wallet.cs_wallet);
+        spkm.SetupGeneration();
+    }
+
+    // 4 scripts per keypool key (P2PK, P2PKH, P2WPKH, P2SH-P2WPKH)
+    // Plus 4 scripts for the seed key
+    auto scripts1 = spkm.GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts1.size(), 84);
+
+    // All keys are active
+    for (const CScript& script : scripts1) {
+        BOOST_CHECK(spkm.IsKeyActive(script));
+    }
+
+    // Requesting single from spkm should not deactivate key
+    CTxDestination dest1;
+    {
+        LOCK(wallet.cs_wallet);
+        auto result = spkm.GetNewDestination(OutputType::BECH32);
+        dest1 = result.value();
+    }
+    CScript script = GetScriptForDestination(dest1);
+    BOOST_CHECK(spkm.IsKeyActive(script));
+
+    // Key pool size did not change
+    auto scripts2 = spkm.GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts2.size(), 84);
+
+    // Use key that is not the next key
+    // (i.e. address gap in wallet recovery)
+    {
+        LOCK(wallet.cs_wallet);
+        LOCK(spkm.cs_KeyStore);
+        auto keys = spkm.MarkReserveKeysAsUsed(5);
+        BOOST_CHECK_EQUAL(keys.size(), 4); // Because we already used one with GetNewDestination
+    }
+
+    // Key pool size did not change
+    auto scripts3 = spkm.GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts3.size(), 84);
+
+    // All keys are still active
+    for (const CScript& script : scripts3) {
+        BOOST_CHECK(spkm.IsKeyActive(script));
+    }
+
+    // When user encrypts wallet for the first time,
+    // all existing keys are removed from active keypool
+    {
+        LOCK(wallet.cs_wallet);
+        // called by EncryptWallet()
+        spkm.SetupGeneration(true);
+    }
+
+    // 20 new keys were added
+    auto scripts4 = spkm.GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts4.size(), 84 * 2);
+
+    // All 10 original keys are now inactive
+    for (const CScript& script : scripts3) {
+        BOOST_CHECK(!spkm.IsKeyActive(script));
+    }
+}
+
+BOOST_AUTO_TEST_CASE(Descriptor_IsKeyActive)
+{
+    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
+    {
+        LOCK(wallet.cs_wallet);
+        wallet.LoadMinVersion(FEATURE_LATEST);
+        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
+        wallet.m_keypool_size = 10;
+        wallet.SetupDescriptorScriptPubKeyMans();
+    }
+    DescriptorScriptPubKeyMan* spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(wallet.GetScriptPubKeyMan(OutputType::BECH32, /*internal=*/false));
+
+    // Start off with 10 pre-generated keys, 1 script each
+    auto scripts1 = spkm->GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts1.size(), 10);
+
+    // All keys are active
+    for (const CScript& script : scripts1) {
+        BOOST_CHECK(spkm->IsKeyActive(script));
+    }
+
+    // Requesting single key from spkm should not deactivate key
+    auto dest1 = spkm->GetNewDestination(OutputType::BECH32);
+    CScript script = GetScriptForDestination(dest1.value());
+    BOOST_CHECK(spkm->IsKeyActive(script));
+
+    // Key pool size did not change
+    auto scripts2 = spkm->GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts2.size(), 10);
+
+    // Use key that is not the next key
+    // (i.e. address gap in wallet recovery)
+    {
+        LOCK(spkm->cs_desc_man);
+        WalletDescriptor descriptor = spkm->GetWalletDescriptor();
+        FlatSigningProvider provider;
+        std::vector<CScript> scripts3;
+        descriptor.descriptor->ExpandFromCache(/*pos=*/5, descriptor.cache, scripts3, provider);
+
+        BOOST_CHECK_EQUAL(scripts3.size(), 1);
+        spkm->MarkUnusedAddresses(scripts3.front());
+    }
+
+    // Key pool size increased to replace used keys
+    auto scripts4 = spkm->GetScriptPubKeys();
+    BOOST_CHECK_EQUAL(scripts4.size(), 16);
+
+    // All keys are still active
+    for (const CScript& script : scripts4) {
+        BOOST_CHECK(spkm->IsKeyActive(script));
+    }
+
+    // When user encrypts wallet for the first time,
+    // all existing keys are removed from active keypool
+    {
+        LOCK(wallet.cs_wallet);
+        // called by EncryptWallet()
+        wallet.SetupDescriptorScriptPubKeyMans();
+    }
+
+    // This SPKM is not affected
+    for (const CScript& script : scripts4) {
+        BOOST_CHECK(spkm->IsKeyActive(script));
+    }
+
+    // ...but at the wallet level all the keys from that SPKM are deactivated
+    int num_script_keys_not_found = 0;
+    for (const CScript& script : scripts4) {
+        if (!wallet.IsDestinationActive(WitnessV0ScriptHash(script))) {
+            ++num_script_keys_not_found;
+        }
+    }
+    BOOST_CHECK_EQUAL(num_script_keys_not_found, 16);
+}
+
 BOOST_AUTO_TEST_SUITE_END()
 } // namespace wallet