walletload_tests.cpp raw

   1  // Copyright (c) 2022-present The Bitcoin Core developers
   2  // Distributed under the MIT software license, see the accompanying
   3  // file COPYING or https://www.opensource.org/licenses/mit-license.php.
   4  
   5  #include <wallet/test/util.h>
   6  #include <wallet/wallet.h>
   7  #include <test/util/common.h>
   8  #include <test/util/logging.h>
   9  #include <test/util/setup_common.h>
  10  
  11  #include <boost/test/unit_test.hpp>
  12  
  13  namespace wallet {
  14  
  15  BOOST_AUTO_TEST_SUITE(walletload_tests)
  16  
  17  class DummyDescriptor final : public Descriptor {
  18  private:
  19      std::string desc;
  20  public:
  21      explicit DummyDescriptor(const std::string& descriptor) : desc(descriptor) {};
  22      ~DummyDescriptor() = default;
  23  
  24      std::string ToString(bool compat_format) const override { return desc; }
  25      std::optional<OutputType> GetOutputType() const override { return OutputType::UNKNOWN; }
  26  
  27      bool IsRange() const override { return false; }
  28      bool IsSolvable() const override { return false; }
  29      bool IsSingleType() const override { return true; }
  30      bool HavePrivateKeys(const SigningProvider&) const override { return false; }
  31      bool ToPrivateString(const SigningProvider& provider, std::string& out) const override { return false; }
  32      bool ToNormalizedString(const SigningProvider& provider, std::string& out, const DescriptorCache* cache = nullptr) const override { return false; }
  33      bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const override { return false; };
  34      bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const override { return false; }
  35      void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const override {}
  36      std::optional<int64_t> ScriptSize() const override { return {}; }
  37      std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
  38      std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
  39      void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override {}
  40      bool HasScripts() const override { return true; }
  41      std::vector<std::string> Warnings() const override { return {}; }
  42      uint32_t GetMaxKeyExpr() const override { return 0; }
  43      size_t GetKeyCount() const override { return 0; }
  44      bool CanSelfExpand() const final { return false; }
  45  };
  46  
  47  BOOST_FIXTURE_TEST_CASE(wallet_load_descriptors, TestingSetup)
  48  {
  49      bilingual_str _error;
  50      std::vector<bilingual_str> _warnings;
  51      std::unique_ptr<WalletDatabase> database = CreateMockableWalletDatabase();
  52      {
  53          // Write unknown active descriptor
  54          WalletBatch batch(*database);
  55          std::string unknown_desc = "trx(tpubD6NzVbkrYhZ4Y4S7m6Y5s9GD8FqEMBy56AGphZXuagajudVZEnYyBahZMgHNCTJc2at82YX6s8JiL1Lohu5A3v1Ur76qguNH4QVQ7qYrBQx/86'/1'/0'/0/*)#8pn8tzdt";
  56          WalletDescriptor wallet_descriptor(std::make_shared<DummyDescriptor>(unknown_desc), 0, 0, 0, 0);
  57          BOOST_CHECK(batch.WriteDescriptor(uint256(), wallet_descriptor));
  58          BOOST_CHECK(batch.WriteActiveScriptPubKeyMan(static_cast<uint8_t>(OutputType::UNKNOWN), uint256(), false));
  59      }
  60  
  61      {
  62          // Now try to load the wallet and verify the error.
  63          const std::shared_ptr<CWallet> wallet(new CWallet(m_node.chain.get(), "", std::move(database)));
  64          BOOST_CHECK_EQUAL(wallet->PopulateWalletFromDB(_error, _warnings), DBErrors::UNKNOWN_DESCRIPTOR);
  65      }
  66  
  67      // Test 2
  68      // Now write a valid descriptor with an invalid ID.
  69      // As the software produces another ID for the descriptor, the loading process must be aborted.
  70      database = CreateMockableWalletDatabase();
  71  
  72      // Verify the error
  73      bool found = false;
  74      DebugLogHelper logHelper("The descriptor ID calculated by the wallet differs from the one in DB", [&](const std::string* s) {
  75          found = true;
  76          return false;
  77      });
  78  
  79      {
  80          // Write valid descriptor with invalid ID
  81          WalletBatch batch(*database);
  82          std::string desc = "wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu";
  83          WalletDescriptor wallet_descriptor(std::make_shared<DummyDescriptor>(desc), 0, 0, 0, 0);
  84          BOOST_CHECK(batch.WriteDescriptor(uint256::ONE, wallet_descriptor));
  85      }
  86  
  87      {
  88          // Now try to load the wallet and verify the error.
  89          const std::shared_ptr<CWallet> wallet(new CWallet(m_node.chain.get(), "", std::move(database)));
  90          BOOST_CHECK_EQUAL(wallet->PopulateWalletFromDB(_error, _warnings), DBErrors::CORRUPT);
  91          BOOST_CHECK(found); // The error must be logged
  92      }
  93  }
  94  
  95  BOOST_AUTO_TEST_SUITE_END()
  96  } // namespace wallet
  97