text: // Copyright (c) 2012-2021 The Bitcoin Core developers
  // Distributed under the MIT software license, see the accompanying
  // file COPYING or http://www.opensource.org/licenses/mit-license.php.
  
  #include <wallet/wallet.h>
  
  #include <any>
  #include <future>
  #include <memory>
  #include <stdint.h>
  #include <vector>
  
  #include <interfaces/chain.h>
  #include <key_io.h>
  #include <node/blockstorage.h>
  #include <node/context.h>
  #include <policy/policy.h>
  #include <rpc/server.h>
  #include <test/util/logging.h>
  #include <test/util/setup_common.h>
  #include <util/translation.h>
  #include <validation.h>
  #include <wallet/coincontrol.h>
  #include <wallet/context.h>
  #include <wallet/receive.h>
  #include <wallet/spend.h>
  #include <wallet/test/util.h>
  #include <wallet/test/wallet_test_fixture.h>
  
  #include <boost/test/unit_test.hpp>
  #include <univalue.h>
  
  using node::MAX_BLOCKFILE_SIZE;
  using node::UnlinkPrunedFiles;
  
  namespace wallet {
  RPCHelpMan importmulti();
  RPCHelpMan dumpwallet();
  RPCHelpMan importwallet();
  
  // Ensure that fee levels defined in the wallet are at least as high
  // as the default levels for node policy.
  static_assert(DEFAULT_TRANSACTION_MINFEE >= DEFAULT_MIN_RELAY_TX_FEE, "wallet minimum fee is smaller than default relay fee");
  static_assert(WALLET_INCREMENTAL_RELAY_FEE >= DEFAULT_INCREMENTAL_RELAY_FEE, "wallet incremental fee is smaller than default incremental relay fee");
  
  BOOST_FIXTURE_TEST_SUITE(wallet_tests, WalletTestingSetup)
  
  static const std::shared_ptr<CWallet> TestLoadWallet(WalletContext& context)
  {
      DatabaseOptions options;
      options.create_flags = WALLET_FLAG_DESCRIPTORS;
      DatabaseStatus status;
      bilingual_str error;
      std::vector<bilingual_str> warnings;
      auto database = MakeWalletDatabase("", options, status, error);
      auto wallet = CWallet::Create(context, "", std::move(database), options.create_flags, error, warnings);
      NotifyWalletLoaded(context, wallet);
      if (context.chain) {
          wallet->postInitProcess();
      }
      return wallet;
  }
  
  static void TestUnloadWallet(std::shared_ptr<CWallet>&& wallet)
  {
      SyncWithValidationInterfaceQueue();
      wallet->m_chain_notifications_handler.reset();
      UnloadWallet(std::move(wallet));
  }
  
  static CMutableTransaction TestSimpleSpend(const CTransaction& from, uint32_t index, const CKey& key, const CScript& pubkey)
  {
      CMutableTransaction mtx;
      mtx.vout.push_back({from.vout[index].nValue - DEFAULT_TRANSACTION_MAXFEE, pubkey});
      mtx.vin.push_back({CTxIn{from.GetHash(), index}});
      FillableSigningProvider keystore;
      keystore.AddKey(key);
      std::map<COutPoint, Coin> coins;
      coins[mtx.vin[0].prevout].out = from.vout[index];
      std::map<int, bilingual_str> input_errors;
      BOOST_CHECK(SignTransaction(mtx, &keystore, coins, SIGHASH_ALL, input_errors));
      return mtx;
  }
  
  static void AddKey(CWallet& wallet, const CKey& key)
  {
      LOCK(wallet.cs_wallet);
      FlatSigningProvider provider;
      std::string error;
      std::unique_ptr<Descriptor> desc = Parse("combo(" + EncodeSecret(key) + ")", provider, error, /* require_checksum=*/ false);
      assert(desc);
      WalletDescriptor w_desc(std::move(desc), 0, 0, 1, 1);
      if (!wallet.AddWalletDescriptor(w_desc, provider, "", false)) assert(false);
  }
  
  BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions, TestChain100Setup)
  {
      // Cap last block file size, and mine new block in a new block file.
      CBlockIndex* oldTip = m_node.chainman->ActiveChain().Tip();
      WITH_LOCK(::cs_main, m_node.chainman->m_blockman.GetBlockFileInfo(oldTip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
      CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
      CBlockIndex* newTip = m_node.chainman->ActiveChain().Tip();
  
      // Verify ScanForWalletTransactions fails to read an unknown start block.
      {
          CWallet wallet(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          {
              LOCK(wallet.cs_wallet);
              wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
              wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          }
          AddKey(wallet, coinbaseKey);
          WalletRescanReserver reserver(wallet);
          reserver.reserve();
          CWallet::ScanResult result = wallet.ScanForWalletTransactions({} /* start_block */, 0 /* start_height */, {} /* max_height */, reserver, false /* update */);
          BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::FAILURE);
          BOOST_CHECK(result.last_failed_block.IsNull());
          BOOST_CHECK(result.last_scanned_block.IsNull());
          BOOST_CHECK(!result.last_scanned_height);
          BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 0);
      }
  
      // Verify ScanForWalletTransactions picks up transactions in both the old
      // and new block files.
      {
          CWallet wallet(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          {
              LOCK(wallet.cs_wallet);
              wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
              wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          }
          AddKey(wallet, coinbaseKey);
          WalletRescanReserver reserver(wallet);
          reserver.reserve();
          CWallet::ScanResult result = wallet.ScanForWalletTransactions(oldTip->GetBlockHash(), oldTip->nHeight, {} /* max_height */, reserver, false /* update */);
          BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::SUCCESS);
          BOOST_CHECK(result.last_failed_block.IsNull());
          BOOST_CHECK_EQUAL(result.last_scanned_block, newTip->GetBlockHash());
          BOOST_CHECK_EQUAL(*result.last_scanned_height, newTip->nHeight);
          BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 100 * COIN);
      }
  
      // Prune the older block file.
      int file_number;
      {
          LOCK(cs_main);
          file_number = oldTip->GetBlockPos().nFile;
          Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
      }
      UnlinkPrunedFiles({file_number});
  
      // Verify ScanForWalletTransactions only picks transactions in the new block
      // file.
      {
          CWallet wallet(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          {
              LOCK(wallet.cs_wallet);
              wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
              wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          }
          AddKey(wallet, coinbaseKey);
          WalletRescanReserver reserver(wallet);
          reserver.reserve();
          CWallet::ScanResult result = wallet.ScanForWalletTransactions(oldTip->GetBlockHash(), oldTip->nHeight, {} /* max_height */, reserver, false /* update */);
          BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::FAILURE);
          BOOST_CHECK_EQUAL(result.last_failed_block, oldTip->GetBlockHash());
          BOOST_CHECK_EQUAL(result.last_scanned_block, newTip->GetBlockHash());
          BOOST_CHECK_EQUAL(*result.last_scanned_height, newTip->nHeight);
          BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 50 * COIN);
      }
  
      // Prune the remaining block file.
      {
          LOCK(cs_main);
          file_number = newTip->GetBlockPos().nFile;
          Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
      }
      UnlinkPrunedFiles({file_number});
  
      // Verify ScanForWalletTransactions scans no blocks.
      {
          CWallet wallet(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          {
              LOCK(wallet.cs_wallet);
              wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
              wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          }
          AddKey(wallet, coinbaseKey);
          WalletRescanReserver reserver(wallet);
          reserver.reserve();
          CWallet::ScanResult result = wallet.ScanForWalletTransactions(oldTip->GetBlockHash(), oldTip->nHeight, {} /* max_height */, reserver, false /* update */);
          BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::FAILURE);
          BOOST_CHECK_EQUAL(result.last_failed_block, newTip->GetBlockHash());
          BOOST_CHECK(result.last_scanned_block.IsNull());
          BOOST_CHECK(!result.last_scanned_height);
          BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 0);
      }
  }
  
  BOOST_FIXTURE_TEST_CASE(importmulti_rescan, TestChain100Setup)
  {
      // Cap last block file size, and mine new block in a new block file.
      CBlockIndex* oldTip = m_node.chainman->ActiveChain().Tip();
      WITH_LOCK(::cs_main, m_node.chainman->m_blockman.GetBlockFileInfo(oldTip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
      CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
      CBlockIndex* newTip = m_node.chainman->ActiveChain().Tip();
  
      // Prune the older block file.
      int file_number;
      {
          LOCK(cs_main);
          file_number = oldTip->GetBlockPos().nFile;
          Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
      }
      UnlinkPrunedFiles({file_number});
  
      // Verify importmulti RPC returns failure for a key whose creation time is
      // before the missing block, and success for a key whose creation time is
      // after.
      {
          const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          wallet->SetupLegacyScriptPubKeyMan();
          WITH_LOCK(wallet->cs_wallet, wallet->SetLastBlockProcessed(newTip->nHeight, newTip->GetBlockHash()));
          WalletContext context;
          context.args = &m_args;
          AddWallet(context, wallet);
          UniValue keys;
          keys.setArray();
          UniValue key;
          key.setObject();
          key.pushKV("scriptPubKey", HexStr(GetScriptForRawPubKey(coinbaseKey.GetPubKey())));
          key.pushKV("timestamp", 0);
          key.pushKV("internal", UniValue(true));
          keys.push_back(key);
          key.clear();
          key.setObject();
          CKey futureKey;
          futureKey.MakeNewKey(true);
          key.pushKV("scriptPubKey", HexStr(GetScriptForRawPubKey(futureKey.GetPubKey())));
          key.pushKV("timestamp", newTip->GetBlockTimeMax() + TIMESTAMP_WINDOW + 1);
          key.pushKV("internal", UniValue(true));
          keys.push_back(key);
          JSONRPCRequest request;
          request.context = &context;
          request.params.setArray();
          request.params.push_back(keys);
  
          UniValue response = importmulti().HandleRequest(request);
          BOOST_CHECK_EQUAL(response.write(),
              strprintf("[{\"success\":false,\"error\":{\"code\":-1,\"message\":\"Rescan failed for key with creation "
                        "timestamp %d. There was an error reading a block from time %d, which is after or within %d "
                        "seconds of key creation, and could contain transactions pertaining to the key. As a result, "
                        "transactions and coins using this key may not appear in the wallet. This error could be caused "
                        "by pruning or data corruption (see bitcoind log for details) and could be dealt with by "
                        "downloading and rescanning the relevant blocks (see -reindex option and rescanblockchain "
                        "RPC).\"}},{\"success\":true}]",
                                0, oldTip->GetBlockTimeMax(), TIMESTAMP_WINDOW));
          RemoveWallet(context, wallet, /* load_on_start= */ std::nullopt);
      }
  }
  
  // Verify importwallet RPC starts rescan at earliest block with timestamp
  // greater or equal than key birthday. Previously there was a bug where
  // importwallet RPC would start the scan at the latest block with timestamp less
  // than or equal to key birthday.
  BOOST_FIXTURE_TEST_CASE(importwallet_rescan, TestChain100Setup)
  {
      // Create two blocks with same timestamp to verify that importwallet rescan
      // will pick up both blocks, not just the first.
      const int64_t BLOCK_TIME = m_node.chainman->ActiveChain().Tip()->GetBlockTimeMax() + 5;
      SetMockTime(BLOCK_TIME);
      m_coinbase_txns.emplace_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
      m_coinbase_txns.emplace_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
  
      // Set key birthday to block time increased by the timestamp window, so
      // rescan will start at the block time.
      const int64_t KEY_TIME = BLOCK_TIME + TIMESTAMP_WINDOW;
      SetMockTime(KEY_TIME);
      m_coinbase_txns.emplace_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
  
      std::string backup_file = fs::PathToString(m_args.GetDataDirNet() / "wallet.backup");
  
      // Import key into wallet and call dumpwallet to create backup file.
      {
          WalletContext context;
          context.args = &m_args;
          const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          {
              auto spk_man = wallet->GetOrCreateLegacyScriptPubKeyMan();
              LOCK2(wallet->cs_wallet, spk_man->cs_KeyStore);
              spk_man->mapKeyMetadata[coinbaseKey.GetPubKey().GetID()].nCreateTime = KEY_TIME;
              spk_man->AddKeyPubKey(coinbaseKey, coinbaseKey.GetPubKey());
  
              AddWallet(context, wallet);
              wallet->SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          }
          JSONRPCRequest request;
          request.context = &context;
          request.params.setArray();
          request.params.push_back(backup_file);
  
          wallet::dumpwallet().HandleRequest(request);
          RemoveWallet(context, wallet, /* load_on_start= */ std::nullopt);
      }
  
      // Call importwallet RPC and verify all blocks with timestamps >= BLOCK_TIME
      // were scanned, and no prior blocks were scanned.
      {
          const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          LOCK(wallet->cs_wallet);
          wallet->SetupLegacyScriptPubKeyMan();
  
          WalletContext context;
          context.args = &m_args;
          JSONRPCRequest request;
          request.context = &context;
          request.params.setArray();
          request.params.push_back(backup_file);
          AddWallet(context, wallet);
          wallet->SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          wallet::importwallet().HandleRequest(request);
          RemoveWallet(context, wallet, /* load_on_start= */ std::nullopt);
  
          BOOST_CHECK_EQUAL(wallet->mapWallet.size(), 3U);
          BOOST_CHECK_EQUAL(m_coinbase_txns.size(), 103U);
          for (size_t i = 0; i < m_coinbase_txns.size(); ++i) {
              bool found = wallet->GetWalletTx(m_coinbase_txns[i]->GetHash());
              bool expected = i >= 100;
              BOOST_CHECK_EQUAL(found, expected);
          }
      }
  }
  
  // Check that GetImmatureCredit() returns a newly calculated value instead of
  // the cached value after a MarkDirty() call.
  //
  // This is a regression test written to verify a bugfix for the immature credit
  // function. Similar tests probably should be written for the other credit and
  // debit functions.
  BOOST_FIXTURE_TEST_CASE(coin_mark_dirty_immature_credit, TestChain100Setup)
  {
      CWallet wallet(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
      CWalletTx wtx{m_coinbase_txns.back(), TxStateConfirmed{m_node.chainman->ActiveChain().Tip()->GetBlockHash(), m_node.chainman->ActiveChain().Height(), /*index=*/0}};
  
      LOCK(wallet.cs_wallet);
      wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
      wallet.SetupDescriptorScriptPubKeyMans();
  
      wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
  
      // Call GetImmatureCredit() once before adding the key to the wallet to
      // cache the current immature credit amount, which is 0.
      BOOST_CHECK_EQUAL(CachedTxGetImmatureCredit(wallet, wtx), 0);
  
      // Invalidate the cached value, add the key, and make sure a new immature
      // credit amount is calculated.
      wtx.MarkDirty();
      AddKey(wallet, coinbaseKey);
      BOOST_CHECK_EQUAL(CachedTxGetImmatureCredit(wallet, wtx), 50*COIN);
  }
  
  static int64_t AddTx(ChainstateManager& chainman, CWallet& wallet, uint32_t lockTime, int64_t mockTime, int64_t blockTime)
  {
      CMutableTransaction tx;
      TxState state = TxStateInactive{};
      tx.nLockTime = lockTime;
      SetMockTime(mockTime);
      CBlockIndex* block = nullptr;
      if (blockTime > 0) {
          LOCK(cs_main);
          auto inserted = chainman.BlockIndex().emplace(std::piecewise_construct, std::make_tuple(GetRandHash()), std::make_tuple());
          assert(inserted.second);
          const uint256& hash = inserted.first->first;
          block = &inserted.first->second;
          block->nTime = blockTime;
          block->phashBlock = &hash;
          state = TxStateConfirmed{hash, block->nHeight, /*index=*/0};
      }
      return wallet.AddToWallet(MakeTransactionRef(tx), state, [&](CWalletTx& wtx, bool /* new_tx */) {
          // Assign wtx.m_state to simplify test and avoid the need to simulate
          // reorg events. Without this, AddToWallet asserts false when the same
          // transaction is confirmed in different blocks.
          wtx.m_state = state;
          return true;
      })->nTimeSmart;
  }
  
  // Simple test to verify assignment of CWalletTx::nSmartTime value. Could be
  // expanded to cover more corner cases of smart time logic.
  BOOST_AUTO_TEST_CASE(ComputeTimeSmart)
  {
      // New transaction should use clock time if lower than block time.
      BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 1, 100, 120), 100);
  
      // Test that updating existing transaction does not change smart time.
      BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 1, 200, 220), 100);
  
      // New transaction should use clock time if there's no block time.
      BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 2, 300, 0), 300);
  
      // New transaction should use block time if lower than clock time.
      BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 3, 420, 400), 400);
  
      // New transaction should use latest entry time if higher than
      // min(block time, clock time).
      BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 4, 500, 390), 400);
  
      // If there are future entries, new transaction should use time of the
      // newest entry that is no more than 300 seconds ahead of the clock time.
      BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 5, 50, 600), 300);
  }
  
  BOOST_AUTO_TEST_CASE(LoadReceiveRequests)
  {
      CTxDestination dest = PKHash();
      LOCK(m_wallet.cs_wallet);
      WalletBatch batch{m_wallet.GetDatabase()};
      m_wallet.SetAddressUsed(batch, dest, true);
      m_wallet.SetAddressReceiveRequest(batch, dest, "0", "val_rr0");
      m_wallet.SetAddressReceiveRequest(batch, dest, "1", "val_rr1");
  
      auto values = m_wallet.GetAddressReceiveRequests();
      BOOST_CHECK_EQUAL(values.size(), 2U);
      BOOST_CHECK_EQUAL(values[0], "val_rr0");
      BOOST_CHECK_EQUAL(values[1], "val_rr1");
  }
  
  // Test some watch-only LegacyScriptPubKeyMan methods by the procedure of loading (LoadWatchOnly),
  // checking (HaveWatchOnly), getting (GetWatchPubKey) and removing (RemoveWatchOnly) a
  // given PubKey, resp. its corresponding P2PK Script. Results of the impact on
  // the address -> PubKey map is dependent on whether the PubKey is a point on the curve
  static void TestWatchOnlyPubKey(LegacyScriptPubKeyMan* spk_man, const CPubKey& add_pubkey)
  {
      CScript p2pk = GetScriptForRawPubKey(add_pubkey);
      CKeyID add_address = add_pubkey.GetID();
      CPubKey found_pubkey;
      LOCK(spk_man->cs_KeyStore);
  
      // all Scripts (i.e. also all PubKeys) are added to the general watch-only set
      BOOST_CHECK(!spk_man->HaveWatchOnly(p2pk));
      spk_man->LoadWatchOnly(p2pk);
      BOOST_CHECK(spk_man->HaveWatchOnly(p2pk));
  
      // only PubKeys on the curve shall be added to the watch-only address -> PubKey map
      bool is_pubkey_fully_valid = add_pubkey.IsFullyValid();
      if (is_pubkey_fully_valid) {
          BOOST_CHECK(spk_man->GetWatchPubKey(add_address, found_pubkey));
          BOOST_CHECK(found_pubkey == add_pubkey);
      } else {
          BOOST_CHECK(!spk_man->GetWatchPubKey(add_address, found_pubkey));
          BOOST_CHECK(found_pubkey == CPubKey()); // passed key is unchanged
      }
  
      spk_man->RemoveWatchOnly(p2pk);
      BOOST_CHECK(!spk_man->HaveWatchOnly(p2pk));
  
      if (is_pubkey_fully_valid) {
          BOOST_CHECK(!spk_man->GetWatchPubKey(add_address, found_pubkey));
          BOOST_CHECK(found_pubkey == add_pubkey); // passed key is unchanged
      }
  }
  
  // Cryptographically invalidate a PubKey whilst keeping length and first byte
  static void PollutePubKey(CPubKey& pubkey)
  {
      std::vector<unsigned char> pubkey_raw(pubkey.begin(), pubkey.end());
      std::fill(pubkey_raw.begin()+1, pubkey_raw.end(), 0);
      pubkey = CPubKey(pubkey_raw);
      assert(!pubkey.IsFullyValid());
      assert(pubkey.IsValid());
  }
  
  // Test watch-only logic for PubKeys
  BOOST_AUTO_TEST_CASE(WatchOnlyPubKeys)
  {
      CKey key;
      CPubKey pubkey;
      LegacyScriptPubKeyMan* spk_man = m_wallet.GetOrCreateLegacyScriptPubKeyMan();
  
      BOOST_CHECK(!spk_man->HaveWatchOnly());
  
      // uncompressed valid PubKey
      key.MakeNewKey(false);
      pubkey = key.GetPubKey();
      assert(!pubkey.IsCompressed());
      TestWatchOnlyPubKey(spk_man, pubkey);
  
      // uncompressed cryptographically invalid PubKey
      PollutePubKey(pubkey);
      TestWatchOnlyPubKey(spk_man, pubkey);
  
      // compressed valid PubKey
      key.MakeNewKey(true);
      pubkey = key.GetPubKey();
      assert(pubkey.IsCompressed());
      TestWatchOnlyPubKey(spk_man, pubkey);
  
      // compressed cryptographically invalid PubKey
      PollutePubKey(pubkey);
      TestWatchOnlyPubKey(spk_man, pubkey);
  
      // invalid empty PubKey
      pubkey = CPubKey();
      TestWatchOnlyPubKey(spk_man, pubkey);
  }
  
  class ListCoinsTestingSetup : public TestChain100Setup
  {
  public:
      ListCoinsTestingSetup()
      {
          CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
          wallet = CreateSyncedWallet(*m_node.chain, m_node.chainman->ActiveChain(), m_args, coinbaseKey);
      }
  
      ~ListCoinsTestingSetup()
      {
          wallet.reset();
      }
  
      CWalletTx& AddTx(CRecipient recipient)
      {
          CTransactionRef tx;
          bilingual_str error;
          CCoinControl dummy;
          FeeCalculation fee_calc_out;
          {
              constexpr int RANDOM_CHANGE_POSITION = -1;
              std::optional<CreatedTransactionResult> txr = CreateTransaction(*wallet, {recipient}, RANDOM_CHANGE_POSITION, error, dummy, fee_calc_out);
              BOOST_CHECK(txr.has_value());
              tx = txr->tx;
          }
          wallet->CommitTransaction(tx, {}, {});
          CMutableTransaction blocktx;
          {
              LOCK(wallet->cs_wallet);
              blocktx = CMutableTransaction(*wallet->mapWallet.at(tx->GetHash()).tx);
          }
          CreateAndProcessBlock({CMutableTransaction(blocktx)}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
  
          LOCK(wallet->cs_wallet);
          wallet->SetLastBlockProcessed(wallet->GetLastBlockHeight() + 1, m_node.chainman->ActiveChain().Tip()->GetBlockHash());
          auto it = wallet->mapWallet.find(tx->GetHash());
          BOOST_CHECK(it != wallet->mapWallet.end());
          it->second.m_state = TxStateConfirmed{m_node.chainman->ActiveChain().Tip()->GetBlockHash(), m_node.chainman->ActiveChain().Height(), /*index=*/1};
          return it->second;
      }
  
      std::unique_ptr<CWallet> wallet;
  };
  
  BOOST_FIXTURE_TEST_CASE(ListCoinsTest, ListCoinsTestingSetup)
  {
      std::string coinbaseAddress = coinbaseKey.GetPubKey().GetID().ToString();
  
      // Confirm ListCoins initially returns 1 coin grouped under coinbaseKey
      // address.
      std::map<CTxDestination, std::vector<COutput>> list;
      {
          LOCK(wallet->cs_wallet);
          list = ListCoins(*wallet);
      }
      BOOST_CHECK_EQUAL(list.size(), 1U);
      BOOST_CHECK_EQUAL(std::get<PKHash>(list.begin()->first).ToString(), coinbaseAddress);
      BOOST_CHECK_EQUAL(list.begin()->second.size(), 1U);
  
      // Check initial balance from one mature coinbase transaction.
      BOOST_CHECK_EQUAL(50 * COIN, GetAvailableBalance(*wallet));
  
      // Add a transaction creating a change address, and confirm ListCoins still
      // returns the coin associated with the change address underneath the
      // coinbaseKey pubkey, even though the change address has a different
      // pubkey.
      AddTx(CRecipient{GetScriptForRawPubKey({}), 1 * COIN, false /* subtract fee */});
      {
          LOCK(wallet->cs_wallet);
          list = ListCoins(*wallet);
      }
      BOOST_CHECK_EQUAL(list.size(), 1U);
      BOOST_CHECK_EQUAL(std::get<PKHash>(list.begin()->first).ToString(), coinbaseAddress);
      BOOST_CHECK_EQUAL(list.begin()->second.size(), 2U);
  
      // Lock both coins. Confirm number of available coins drops to 0.
      {
          LOCK(wallet->cs_wallet);
          std::vector<COutput> available;
          AvailableCoins(*wallet, available);
          BOOST_CHECK_EQUAL(available.size(), 2U);
      }
      for (const auto& group : list) {
          for (const auto& coin : group.second) {
              LOCK(wallet->cs_wallet);
              wallet->LockCoin(coin.outpoint);
          }
      }
      {
          LOCK(wallet->cs_wallet);
          std::vector<COutput> available;
          AvailableCoins(*wallet, available);
          BOOST_CHECK_EQUAL(available.size(), 0U);
      }
      // Confirm ListCoins still returns same result as before, despite coins
      // being locked.
      {
          LOCK(wallet->cs_wallet);
          list = ListCoins(*wallet);
      }
      BOOST_CHECK_EQUAL(list.size(), 1U);
      BOOST_CHECK_EQUAL(std::get<PKHash>(list.begin()->first).ToString(), coinbaseAddress);
      BOOST_CHECK_EQUAL(list.begin()->second.size(), 2U);
  }
  
  BOOST_FIXTURE_TEST_CASE(wallet_disableprivkeys, TestChain100Setup)
  {
      {
          const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          wallet->SetupLegacyScriptPubKeyMan();
          wallet->SetMinVersion(FEATURE_LATEST);
          wallet->SetWalletFlag(WALLET_FLAG_DISABLE_PRIVATE_KEYS);
          BOOST_CHECK(!wallet->TopUpKeyPool(1000));
          CTxDestination dest;
          bilingual_str error;
          BOOST_CHECK(!wallet->GetNewDestination(OutputType::BECH32, "", dest, error));
      }
      {
          const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", m_args, CreateDummyWalletDatabase());
          LOCK(wallet->cs_wallet);
          wallet->SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
          wallet->SetMinVersion(FEATURE_LATEST);
          wallet->SetWalletFlag(WALLET_FLAG_DISABLE_PRIVATE_KEYS);
          CTxDestination dest;
          bilingual_str error;
          BOOST_CHECK(!wallet->GetNewDestination(OutputType::BECH32, "", dest, error));
      }
  }
  
  // Explicit calculation which is used to test the wallet constant
  // We get the same virtual size due to rounding(weight/4) for both use_max_sig values
  static size_t CalculateNestedKeyhashInputSize(bool use_max_sig)
  {
      // Generate ephemeral valid pubkey
      CKey key;
      key.MakeNewKey(true);
      CPubKey pubkey = key.GetPubKey();
  
      // Generate pubkey hash
      uint160 key_hash(Hash160(pubkey));
  
      // Create inner-script to enter into keystore. Key hash can't be 0...
      CScript inner_script = CScript() << OP_0 << std::vector<unsigned char>(key_hash.begin(), key_hash.end());
  
      // Create outer P2SH script for the output
      uint160 script_id(Hash160(inner_script));
      CScript script_pubkey = CScript() << OP_HASH160 << std::vector<unsigned char>(script_id.begin(), script_id.end()) << OP_EQUAL;
  
      // Add inner-script to key store and key to watchonly
      FillableSigningProvider keystore;
      keystore.AddCScript(inner_script);
      keystore.AddKeyPubKey(key, pubkey);
  
      // Fill in dummy signatures for fee calculation.
      SignatureData sig_data;
  
      if (!ProduceSignature(keystore, use_max_sig ? DUMMY_MAXIMUM_SIGNATURE_CREATOR : DUMMY_SIGNATURE_CREATOR, script_pubkey, sig_data)) {
          // We're hand-feeding it correct arguments; shouldn't happen
          assert(false);
      }
  
      CTxIn tx_in;
      UpdateInput(tx_in, sig_data);
      return (size_t)GetVirtualTransactionInputSize(tx_in);
  }
  
  BOOST_FIXTURE_TEST_CASE(dummy_input_size_test, TestChain100Setup)
  {
      BOOST_CHECK_EQUAL(CalculateNestedKeyhashInputSize(false), DUMMY_NESTED_P2WPKH_INPUT_SIZE);
      BOOST_CHECK_EQUAL(CalculateNestedKeyhashInputSize(true), DUMMY_NESTED_P2WPKH_INPUT_SIZE);
  }
  
  bool malformed_descriptor(std::ios_base::failure e)
  {
      std::string s(e.what());
      return s.find("Missing checksum") != std::string::npos;
  }
  
  BOOST_FIXTURE_TEST_CASE(wallet_descriptor_test, BasicTestingSetup)
  {
      std::vector<unsigned char> malformed_record;
      CVectorWriter vw(0, 0, malformed_record, 0);
      vw << std::string("notadescriptor");
      vw << (uint64_t)0;
      vw << (int32_t)0;
      vw << (int32_t)0;
      vw << (int32_t)1;
  
      SpanReader vr{0, 0, malformed_record};
      WalletDescriptor w_desc;
      BOOST_CHECK_EXCEPTION(vr >> w_desc, std::ios_base::failure, malformed_descriptor);
  }
  
  //! Test CWallet::Create() and its behavior handling potential race
  //! conditions if it's called the same time an incoming transaction shows up in
  //! the mempool or a new block.
  //!
  //! It isn't possible to verify there aren't race condition in every case, so
  //! this test just checks two specific cases and ensures that timing of
  //! notifications in these cases doesn't prevent the wallet from detecting
  //! transactions.
  //!
  //! In the first case, block and mempool transactions are created before the
  //! wallet is loaded, but notifications about these transactions are delayed
  //! until after it is loaded. The notifications are superfluous in this case, so
  //! the test verifies the transactions are detected before they arrive.
  //!
  //! In the second case, block and mempool transactions are created after the
  //! wallet rescan and notifications are immediately synced, to verify the wallet
  //! must already have a handler in place for them, and there's no gap after
  //! rescanning where new transactions in new blocks could be lost.
  BOOST_FIXTURE_TEST_CASE(CreateWallet, TestChain100Setup)
  {
      m_args.ForceSetArg("-unsafesqlitesync", "1");
      // Create new wallet with known key and unload it.
      WalletContext context;
      context.args = &m_args;
      context.chain = m_node.chain.get();
      auto wallet = TestLoadWallet(context);
      CKey key;
      key.MakeNewKey(true);
      AddKey(*wallet, key);
      TestUnloadWallet(std::move(wallet));
  
  
      // Add log hook to detect AddToWallet events from rescans, blockConnected,
      // and transactionAddedToMempool notifications
      int addtx_count = 0;
      DebugLogHelper addtx_counter("[default wallet] AddToWallet", [&](const std::string* s) {
          if (s) ++addtx_count;
          return false;
      });
  
  
      bool rescan_completed = false;
      DebugLogHelper rescan_check("[default wallet] Rescan completed", [&](const std::string* s) {
          if (s) rescan_completed = true;
          return false;
      });
  
  
      // Block the queue to prevent the wallet receiving blockConnected and
      // transactionAddedToMempool notifications, and create block and mempool
      // transactions paying to the wallet
      std::promise<void> promise;
      CallFunctionInValidationInterfaceQueue([&promise] {
          promise.get_future().wait();
      });
      std::string error;
      m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
      auto block_tx = TestSimpleSpend(*m_coinbase_txns[0], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
      m_coinbase_txns.push_back(CreateAndProcessBlock({block_tx}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
      auto mempool_tx = TestSimpleSpend(*m_coinbase_txns[1], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
      BOOST_CHECK(m_node.chain->broadcastTransaction(MakeTransactionRef(mempool_tx), DEFAULT_TRANSACTION_MAXFEE, false, error));
  
  
      // Reload wallet and make sure new transactions are detected despite events
      // being blocked
      wallet = TestLoadWallet(context);
      BOOST_CHECK(rescan_completed);
      BOOST_CHECK_EQUAL(addtx_count, 2);
      {
          LOCK(wallet->cs_wallet);
          BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_tx.GetHash()), 1U);
          BOOST_CHECK_EQUAL(wallet->mapWallet.count(mempool_tx.GetHash()), 1U);
      }
  
  
      // Unblock notification queue and make sure stale blockConnected and
      // transactionAddedToMempool events are processed
      promise.set_value();
      SyncWithValidationInterfaceQueue();
      BOOST_CHECK_EQUAL(addtx_count, 4);
  
  
      TestUnloadWallet(std::move(wallet));
  
  
      // Load wallet again, this time creating new block and mempool transactions
      // paying to the wallet as the wallet finishes loading and syncing the
      // queue so the events have to be handled immediately. Releasing the wallet
      // lock during the sync is a little artificial but is needed to avoid a
      // deadlock during the sync and simulates a new block notification happening
      // as soon as possible.
      addtx_count = 0;
      auto handler = HandleLoadWallet(context, [&](std::unique_ptr<interfaces::Wallet> wallet) {
              BOOST_CHECK(rescan_completed);
              m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
              block_tx = TestSimpleSpend(*m_coinbase_txns[2], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
              m_coinbase_txns.push_back(CreateAndProcessBlock({block_tx}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
              mempool_tx = TestSimpleSpend(*m_coinbase_txns[3], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
              BOOST_CHECK(m_node.chain->broadcastTransaction(MakeTransactionRef(mempool_tx), DEFAULT_TRANSACTION_MAXFEE, false, error));
              SyncWithValidationInterfaceQueue();
          });
      wallet = TestLoadWallet(context);
      BOOST_CHECK_EQUAL(addtx_count, 4);
      {
          LOCK(wallet->cs_wallet);
          BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_tx.GetHash()), 1U);
          BOOST_CHECK_EQUAL(wallet->mapWallet.count(mempool_tx.GetHash()), 1U);
      }
  
  
      TestUnloadWallet(std::move(wallet));
  }
  
  BOOST_FIXTURE_TEST_CASE(CreateWalletWithoutChain, BasicTestingSetup)
  {
      WalletContext context;
      context.args = &m_args;
      auto wallet = TestLoadWallet(context);
      BOOST_CHECK(wallet);
      UnloadWallet(std::move(wallet));
  }
  
  BOOST_FIXTURE_TEST_CASE(ZapSelectTx, TestChain100Setup)
  {
      m_args.ForceSetArg("-unsafesqlitesync", "1");
      WalletContext context;
      context.args = &m_args;
      context.chain = m_node.chain.get();
      auto wallet = TestLoadWallet(context);
      CKey key;
      key.MakeNewKey(true);
      AddKey(*wallet, key);
  
      std::string error;
      m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
      auto block_tx = TestSimpleSpend(*m_coinbase_txns[0], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
      CreateAndProcessBlock({block_tx}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
  
      SyncWithValidationInterfaceQueue();
  
      {
          auto block_hash = block_tx.GetHash();
          auto prev_hash = m_coinbase_txns[0]->GetHash();
  
          LOCK(wallet->cs_wallet);
          BOOST_CHECK(wallet->HasWalletSpend(prev_hash));
          BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_hash), 1u);
  
          std::vector<uint256> vHashIn{ block_hash }, vHashOut;
          BOOST_CHECK_EQUAL(wallet->ZapSelectTx(vHashIn, vHashOut), DBErrors::LOAD_OK);
  
          BOOST_CHECK(!wallet->HasWalletSpend(prev_hash));
          BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_hash), 0u);
      }
  
      TestUnloadWallet(std::move(wallet));
  }
  
  BOOST_AUTO_TEST_SUITE_END()
  } // namespace wallet
  