Merge bitcoin/bitcoin#25942: test: add ismine test for descriptor ScriptPubKeyMan

1b77db2653 test: add `ismine` test for descriptor scriptpubkeyman (w0xlt)

Pull request description:

  Currently `src/wallet/test/ismine_tests.cpp` has tests for the legacy ScriptPubKeyMan only.
  This PR adds tests for the descriptor ScriptPubKeyMan.

ACKs for top commit:
  ishaanam:
    ACK 1b77db2653
  achow101:
    ACK 1b77db2653
  furszy:
    ACK 1b77db26 with a non-blocking comment.

Tree-SHA512: 977b5d1e71f9468331aeb4ebaf3708dd651f9f3018d4544a395b87ca6d7fb8bfa6d20acc1a4f6e096e240e81d30fb7a6e8add190e52536e7a3cb5a80f392883f

src/wallet/test/ismine_tests.cpp

@@ -3,6 +3,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include <key.h>
+#include <key_io.h>
 #include <node/context.h>
 #include <script/script.h>
 #include <script/standard.h>
@@ -16,6 +17,25 @@
 namespace wallet {
 BOOST_FIXTURE_TEST_SUITE(ismine_tests, BasicTestingSetup)
 
+wallet::ScriptPubKeyMan* CreateDescriptor(CWallet& keystore, const std::string& desc_str, const bool success)
+{
+    keystore.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
+
+    FlatSigningProvider keys;
+    std::string error;
+    std::unique_ptr<Descriptor> parsed_desc = Parse(desc_str, keys, error, false);
+    BOOST_CHECK(success == (parsed_desc != nullptr));
+    if (!success) return nullptr;
+
+    const int64_t range_start = 0, range_end = 1, next_index = 0, timestamp = 1;
+
+    WalletDescriptor w_desc(std::move(parsed_desc), timestamp, range_start, range_end, next_index);
+
+    LOCK(keystore.cs_wallet);
+
+    return Assert(keystore.AddWalletDescriptor(w_desc, keys,/*label=*/"", /*internal=*/false));
+};
+
 BOOST_AUTO_TEST_CASE(ismine_standard)
 {
     CKey keys[2];
@@ -33,7 +53,7 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
     CScript scriptPubKey;
     isminetype result;
 
-    // P2PK compressed
+    // P2PK compressed - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -52,7 +72,19 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2PK uncompressed
+    // P2PK compressed - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "pk(" + EncodeSecret(keys[0]) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        scriptPubKey = GetScriptForRawPubKey(pubkeys[0]);
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2PK uncompressed - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -71,7 +103,19 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2PKH compressed
+    // P2PK uncompressed - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "pk(" + EncodeSecret(uncompressedKey) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        scriptPubKey = GetScriptForRawPubKey(uncompressedPubkey);
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2PKH compressed - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -90,7 +134,19 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2PKH uncompressed
+    // P2PKH compressed - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "pkh(" + EncodeSecret(keys[0]) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        scriptPubKey = GetScriptForDestination(PKHash(pubkeys[0]));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2PKH uncompressed - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -109,7 +165,19 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2SH
+    // P2PKH uncompressed - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "pkh(" + EncodeSecret(uncompressedKey) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        scriptPubKey = GetScriptForDestination(PKHash(uncompressedPubkey));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2SH - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -136,7 +204,20 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // (P2PKH inside) P2SH inside P2SH (invalid)
+    // P2SH - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "sh(pkh(" + EncodeSecret(keys[0]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        CScript redeemScript = GetScriptForDestination(PKHash(pubkeys[0]));
+        scriptPubKey = GetScriptForDestination(ScriptHash(redeemScript));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // (P2PKH inside) P2SH inside P2SH (invalid) - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -155,7 +236,16 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // (P2PKH inside) P2SH inside P2WSH (invalid)
+    // (P2PKH inside) P2SH inside P2SH (invalid) - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "sh(sh(" + EncodeSecret(keys[0]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, false);
+        BOOST_CHECK_EQUAL(spk_manager, nullptr);
+    }
+
+    // (P2PKH inside) P2SH inside P2WSH (invalid) - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -174,7 +264,16 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // P2WPKH inside P2WSH (invalid)
+    // (P2PKH inside) P2SH inside P2WSH (invalid) - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "wsh(sh(" + EncodeSecret(keys[0]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, false);
+        BOOST_CHECK_EQUAL(spk_manager, nullptr);
+    }
+
+    // P2WPKH inside P2WSH (invalid) - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -191,7 +290,16 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // (P2PKH inside) P2WSH inside P2WSH (invalid)
+    // P2WPKH inside P2WSH (invalid) - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "wsh(wpkh(" + EncodeSecret(keys[0]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, false);
+        BOOST_CHECK_EQUAL(spk_manager, nullptr);
+    }
+
+    // (P2PKH inside) P2WSH inside P2WSH (invalid) - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -210,7 +318,16 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // P2WPKH compressed
+    // (P2PKH inside) P2WSH inside P2WSH (invalid) - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "wsh(wsh(" + EncodeSecret(keys[0]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, false);
+        BOOST_CHECK_EQUAL(spk_manager, nullptr);
+    }
+
+    // P2WPKH compressed - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -226,7 +343,19 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2WPKH uncompressed
+    // P2WPKH compressed - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "wpkh(" + EncodeSecret(keys[0]) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        scriptPubKey = GetScriptForDestination(WitnessV0KeyHash(pubkeys[0]));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2WPKH uncompressed - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -247,7 +376,16 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // scriptPubKey multisig
+    // P2WPKH uncompressed (invalid) - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "wpkh(" + EncodeSecret(uncompressedKey) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, false);
+        BOOST_CHECK_EQUAL(spk_manager, nullptr);
+    }
+
+    // scriptPubKey multisig - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -282,7 +420,19 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // P2SH multisig
+    // scriptPubKey multisig - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+        std::string desc_str = "multi(2, " + EncodeSecret(uncompressedKey) + ", " + EncodeSecret(keys[1]) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        scriptPubKey = GetScriptForMultisig(2, {uncompressedPubkey, pubkeys[1]});
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2SH multisig - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -305,7 +455,21 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2WSH multisig with compressed keys
+    // P2SH multisig - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+
+        std::string desc_str = "sh(multi(2, " + EncodeSecret(uncompressedKey) + ", " + EncodeSecret(keys[1]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        CScript redeemScript = GetScriptForMultisig(2, {uncompressedPubkey, pubkeys[1]});
+        scriptPubKey = GetScriptForDestination(ScriptHash(redeemScript));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2WSH multisig with compressed keys - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -334,7 +498,21 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
-    // P2WSH multisig with uncompressed key
+    // P2WSH multisig with compressed keys - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+
+        std::string desc_str = "wsh(multi(2, " + EncodeSecret(keys[0]) + ", " + EncodeSecret(keys[1]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        CScript redeemScript = GetScriptForMultisig(2, {pubkeys[0], pubkeys[1]});
+        scriptPubKey = GetScriptForDestination(WitnessV0ScriptHash(redeemScript));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // P2WSH multisig with uncompressed key - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -363,7 +541,17 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 0);
     }
 
-    // P2WSH multisig wrapped in P2SH
+    // P2WSH multisig with uncompressed key (invalid) - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+
+        std::string desc_str = "wsh(multi(2, " + EncodeSecret(uncompressedKey) + ", " + EncodeSecret(keys[1]) + "))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, false);
+        BOOST_CHECK_EQUAL(spk_manager, nullptr);
+    }
+
+    // P2WSH multisig wrapped in P2SH - Legacy
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
         keystore.SetupLegacyScriptPubKeyMan();
@@ -393,6 +581,83 @@ BOOST_AUTO_TEST_CASE(ismine_standard)
         BOOST_CHECK(keystore.GetLegacyScriptPubKeyMan()->GetScriptPubKeys().count(scriptPubKey) == 1);
     }
 
+    // P2WSH multisig wrapped in P2SH - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+
+        std::string desc_str = "sh(wsh(multi(2, " + EncodeSecret(keys[0]) + ", " + EncodeSecret(keys[1]) + ")))";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        CScript witnessScript = GetScriptForMultisig(2, {pubkeys[0], pubkeys[1]});
+        CScript redeemScript = GetScriptForDestination(WitnessV0ScriptHash(witnessScript));
+        scriptPubKey = GetScriptForDestination(ScriptHash(redeemScript));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
+    // Combo - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+
+        std::string desc_str = "combo(" + EncodeSecret(keys[0]) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        // Test P2PK
+        result = spk_manager->IsMine(GetScriptForRawPubKey(pubkeys[0]));
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+
+        // Test P2PKH
+        result = spk_manager->IsMine(GetScriptForDestination(PKHash(pubkeys[0])));
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+
+        // Test P2SH (combo descriptor does not describe P2SH)
+        CScript redeemScript = GetScriptForDestination(PKHash(pubkeys[0]));
+        scriptPubKey = GetScriptForDestination(ScriptHash(redeemScript));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_NO);
+
+        // Test P2WPKH
+        scriptPubKey = GetScriptForDestination(WitnessV0KeyHash(pubkeys[0]));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+
+        // P2SH-P2WPKH output
+        redeemScript = GetScriptForDestination(WitnessV0KeyHash(pubkeys[0]));
+        scriptPubKey = GetScriptForDestination(ScriptHash(redeemScript));
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+
+        // Test P2TR (combo descriptor does not describe P2TR)
+        XOnlyPubKey xpk(pubkeys[0]);
+        Assert(xpk.IsFullyValid());
+        TaprootBuilder builder;
+        builder.Finalize(xpk);
+        WitnessV1Taproot output = builder.GetOutput();
+        scriptPubKey = GetScriptForDestination(output);
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_NO);
+    }
+
+    // Taproot - Descriptor
+    {
+        CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());
+
+        std::string desc_str = "tr(" + EncodeSecret(keys[0]) + ")";
+
+        auto spk_manager = CreateDescriptor(keystore, desc_str, true);
+
+        XOnlyPubKey xpk(pubkeys[0]);
+        Assert(xpk.IsFullyValid());
+        TaprootBuilder builder;
+        builder.Finalize(xpk);
+        WitnessV1Taproot output = builder.GetOutput();
+        scriptPubKey = GetScriptForDestination(output);
+        result = spk_manager->IsMine(scriptPubKey);
+        BOOST_CHECK_EQUAL(result, ISMINE_SPENDABLE);
+    }
+
     // OP_RETURN
     {
         CWallet keystore(chain.get(), "", m_args, CreateDummyWalletDatabase());