// Copyright (c) 2012-present 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/scan.h>

#include <wallet/wallet.h>

#include <array>

#include <cstddef>

#include <cstdint>

#include <future>

#include <limits>

#include <memory>

#include <optional>

#include <string>

#include <utility>

#include <vector>

#include <addresstype.h>

#include <blockfilter.h>

#include <chain.h>

#include <consensus/validation.h>

#include <index/blockfilterindex.h>

#include <interfaces/chain.h>

#include <key_io.h>

#include <logging.h>

#include <node/blockstorage.h>

#include <node/types.h>

#include <policy/policy.h>

#include <rpc/server.h>

#include <script/descriptor.h>

#include <script/solver.h>

#include <test/util/common.h>

#include <test/util/logging.h>

#include <test/util/random.h>

#include <test/util/setup_common.h>

#include <util/byte_units.h>

#include <util/translation.h>

#include <validation.h>

#include <validationinterface.h>

#include <wallet/coincontrol.h>

#include <wallet/context.h>

#include <wallet/imports.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;

namespace wallet {

// 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 CMutableTransaction TestSimpleSpend(const CTransaction& from, uint32_t index, const CKey& key, const CScript& pubkey)

{

    CMutableTransaction mtx;

    mtx.vout.emplace_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_type = SIGHASH_ALL}, input_errors));

    return mtx;

}

static void AddKey(CWallet& wallet, const CKey& key)

{

    LOCK(wallet.cs_wallet);

    FlatSigningProvider provider;

    std::string error;

    auto descs = Parse("combo(" + EncodeSecret(key) + ")", provider, error, /* require_checksum=*/ false);

    assert(descs.size() == 1);

    auto& desc = descs.at(0);

    WalletDescriptor w_desc(std::move(desc), 0, 0, 1, 1);

    Assert(wallet.AddWalletDescriptor(w_desc, provider, "", false));

}

BOOST_AUTO_TEST_CASE(reject_invalid_descriptor_ranges)

{

    const int height{*Assert(m_node.chain->getHeight())};

    {

        LOCK(m_wallet.cs_wallet);

        m_wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

        m_wallet.SetLastBlockProcessed(height, m_node.chain->getBlockHash(height));

    }

    CExtKey ext_key;

    ext_key.SetSeed(std::array<std::byte, 32>{});

    const std::string descriptor_without_checksum{"wpkh(" + EncodeExtKey(ext_key) + "/*)"};

    const std::string descriptor{descriptor_without_checksum + "#" + GetDescriptorChecksum(descriptor_without_checksum)};

    const std::array invalid_ranges{

        std::pair{std::pair<int64_t, int64_t>{2, 1}, "Range specified as [begin,end] must not have begin after end"},

        std::pair{std::pair<int64_t, int64_t>{-1, 10}, "Range should be greater or equal than 0"},

        std::pair{std::pair<int64_t, int64_t>{0, 1'000'000}, "Range is too large"},

        std::pair{std::pair<int64_t, int64_t>{0, std::numeric_limits<int64_t>::max()}, "End of range is too high"},

        std::pair{std::pair<int64_t, int64_t>{0, 1LL << 31}, "End of range is too high"},

    };

    for (const auto& [range, expected_error] : invalid_ranges) {

        std::vector requests{ImportDescriptorRequest{

            .descriptor = descriptor,

            .label = {},

            .timestamp = 0,

            .active = false,

            .internal = std::nullopt,

            .range = range,

            .next_index = std::nullopt,

        }};

        const auto results{ProcessDescriptorsImport(m_wallet, requests)};

        BOOST_REQUIRE_EQUAL(results.size(), 1U);

        BOOST_REQUIRE(results.front().error.has_value());

        BOOST_CHECK(results.front().error->wallet_error.code == WalletErrorCode::InvalidParameter);

        BOOST_CHECK_EQUAL(results.front().error->wallet_error.message.original, expected_error);

        BOOST_CHECK(!results.front().error->is_general_error);

    }

}

BOOST_FIXTURE_TEST_CASE(update_non_range_descriptor, TestingSetup)

{

    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

    {

        LOCK(wallet.cs_wallet);

        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

        auto key{GenerateRandomKey()};

        auto desc_str{"combo(" + EncodeSecret(key) + ")"};

        FlatSigningProvider provider;

        std::string error;

        auto descs{Parse(desc_str, provider, error, /* require_checksum=*/ false)};

        auto& desc{descs.at(0)};

        WalletDescriptor w_desc{std::move(desc), 0, 0, 0, 0};

        BOOST_CHECK(wallet.AddWalletDescriptor(w_desc, provider, "", false));

        // Wallet should update the non-range descriptor successfully

        BOOST_CHECK(wallet.AddWalletDescriptor(w_desc, provider, "", 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 = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return 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 = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());

    // Verify Scan fails to read an unknown start block.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            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();

        ScanResult result = wallet.Scanner().Scan(/*start_block=*/{}, /*start_height=*/0, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, 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 Scan picks up transactions in both the old

    // and new block files.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

            wallet.SetLastBlockProcessed(newTip->nHeight, newTip->GetBlockHash());

        }

        AddKey(wallet, coinbaseKey);

        WalletRescanReserver reserver(wallet);

        std::chrono::steady_clock::time_point fake_time;

        reserver.setNow([&] { fake_time += 60s; return fake_time; });

        reserver.reserve();

        {

            CBlockLocator locator;

            BOOST_CHECK(WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));

            BOOST_REQUIRE(!locator.IsNull());

            BOOST_CHECK(locator.vHave.front() == newTip->GetBlockHash());

        }

        ScanResult result = wallet.Scanner().Scan(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*save_progress=*/true);

        BOOST_CHECK_EQUAL(result.status, 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);

        {

            CBlockLocator locator;

            BOOST_CHECK(WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));

            BOOST_REQUIRE(!locator.IsNull());

            BOOST_CHECK(locator.vHave.front() == newTip->GetBlockHash());

        }

    }

    // 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);

    }

    m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});

    // Verify Scan only picks transactions in the new block

    // file.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            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();

        ScanResult result = wallet.Scanner().Scan(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, 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);

    }

    m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});

    // Verify Scan scans no blocks.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            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();

        ScanResult result = wallet.Scanner().Scan(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, 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(scan_for_wallet_transactions_reorged_block, TestChain100Setup)

{

    BOOST_REQUIRE(InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1_MiB, /*f_memory=*/true));

    BlockFilterIndex& filter_index{*Assert(GetBlockFilterIndex(BlockFilterType::BASIC))};

    BOOST_REQUIRE(filter_index.Init());

    filter_index.Sync();

    // Reorg the tip out of the active chain: invalidate it, then mine a

    // longer replacement branch paying a script unrelated to the wallets

    // below.

    CBlockIndex* stale_block = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());

    const uint256 stale_hash{stale_block->GetBlockHash()};

    const int stale_height{stale_block->nHeight};

    BlockValidationState state;

    BOOST_REQUIRE(m_node.chainman->ActiveChainstate().InvalidateBlock(state, stale_block));

    const CScript replacement_script{GetScriptForRawPubKey(GenerateRandomKey().GetPubKey())};

    CreateAndProcessBlock({}, replacement_script);

    CreateAndProcessBlock({}, replacement_script);

    BOOST_REQUIRE(filter_index.BlockUntilSyncedToCurrentChain());

    {

        LOCK(Assert(m_node.chainman)->GetMutex());

        BOOST_REQUIRE(!m_node.chainman->ActiveChain().Contains(*stale_block));

        BOOST_REQUIRE_EQUAL(m_node.chainman->ActiveChain().Height(), stale_height + 1);

    }

    {

        BlockFilter filter;

        BOOST_REQUIRE(filter_index.LookupFilter(stale_block, filter));

    }

    // Test wallet whose scripts do not match the stale block's filter.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

            wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());

        }

        WalletRescanReserver reserver(wallet);

        reserver.reserve();

        ScanResult result = wallet.Scanner().Scan(stale_hash, stale_height, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, ScanResult::SUCCESS);

        BOOST_CHECK(result.last_failed_block.IsNull());

        BOOST_CHECK_EQUAL(result.last_scanned_block, stale_hash);

        BOOST_CHECK_EQUAL(*result.last_scanned_height, stale_height);

    }

    // Test wallet whose scripts do match the stale block's filter.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

            wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());

        }

        AddKey(wallet, coinbaseKey); // the stale block's coinbase pays coinbaseKey

        WalletRescanReserver reserver(wallet);

        reserver.reserve();

        ScanResult result = wallet.Scanner().Scan(stale_hash, stale_height, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, ScanResult::FAILURE);

        BOOST_CHECK_EQUAL(result.last_failed_block, stale_hash);

        BOOST_CHECK(result.last_scanned_block.IsNull());

        BOOST_CHECK(!result.last_scanned_height);

        BOOST_CHECK(WITH_LOCK(wallet.cs_wallet, return wallet.mapWallet.empty()));

    }

    // Prune the stale block's file — the block is now not active AND unreadable.

    int file_number;

    {

        LOCK(cs_main);

        file_number = stale_block->GetBlockPos().nFile;

        Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);

    }

    m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            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();

        ScanResult result = wallet.Scanner().Scan(stale_hash, stale_height, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, ScanResult::FAILURE);

        BOOST_CHECK_EQUAL(result.last_failed_block, stale_hash);

        BOOST_CHECK(result.last_scanned_block.IsNull());

        BOOST_CHECK(!result.last_scanned_height);

        BOOST_CHECK(WITH_LOCK(wallet.cs_wallet, return wallet.mapWallet.empty()));

    }

    filter_index.Stop();

    BOOST_REQUIRE(DestroyBlockFilterIndex(BlockFilterType::BASIC));

}

BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_abort, TestChain100Setup)

{

    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

    uint256 genesis_hash;

    {

        LOCK(wallet.cs_wallet);

        LOCK(Assert(m_node.chainman)->GetMutex());

        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

        wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());

        genesis_hash = m_node.chainman->ActiveChain().Genesis()->GetBlockHash();

    }

    // An abort requested while no rescan is held is stale and must

    // not cancel a later scan.

    wallet.Scanner().Abort();

    WalletRescanReserver reserver(wallet);

    BOOST_CHECK(reserver.reserve());

    BOOST_CHECK(!wallet.Scanner().IsAborting());

    // An abort requested after the reservation but before the scan starts

    // (e.g. while importdescriptors is still deriving keys) must cancel the

    // scan.

    wallet.Scanner().Abort();

    ScanResult result = wallet.Scanner().Scan(genesis_hash, /*start_height=*/0, /*max_height=*/{}, reserver, /*save_progress=*/false);

    BOOST_CHECK_EQUAL(result.status, ScanResult::USER_ABORT);

    BOOST_CHECK(result.last_scanned_block.IsNull());

    BOOST_CHECK(!result.last_scanned_height);

    BOOST_CHECK(result.last_failed_block.IsNull());

}

BOOST_FIXTURE_TEST_CASE(wallet_rescan_reserver, TestingSetup)

{

    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

    // No scan in progress: accessors report idle state.

    BOOST_CHECK(!wallet.Scanner().IsScanning());

    BOOST_CHECK(wallet.Scanner().ScanningDuration() == SteadyClock::duration{});

    BOOST_CHECK_EQUAL(wallet.Scanner().ScanningProgress(), 0.0);

    {

        WalletRescanReserver first_reserver(wallet);

        BOOST_CHECK(first_reserver.reserve());

        BOOST_CHECK(first_reserver.isReserved());

        BOOST_CHECK(wallet.Scanner().IsScanning());

        BOOST_CHECK(!wallet.Scanner().IsScanningWithPassphrase());

        BOOST_CHECK_EQUAL(wallet.Scanner().ScanningProgress(), 0.0);

        // Only one reservation can be held at a time.

        WalletRescanReserver second_reserver(wallet);

        BOOST_CHECK(!second_reserver.reserve());

        BOOST_CHECK(!second_reserver.isReserved());

    }

    // Destroying the reserver (RAII) clears the scanning state.

    BOOST_CHECK(!wallet.Scanner().IsScanning());

    {

        WalletRescanReserver passphrase_reserver(wallet);

        BOOST_CHECK(passphrase_reserver.reserve(/*with_passphrase=*/true));

        BOOST_CHECK(wallet.Scanner().IsScanningWithPassphrase());

    }

    BOOST_CHECK(!wallet.Scanner().IsScanningWithPassphrase());

}

BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_bounded, TestChain100Setup)

{

    uint256 genesis_hash, max_hash, tip_hash;

    int max_height, tip_height;

    {

        LOCK(Assert(m_node.chainman)->GetMutex());

        genesis_hash = m_node.chainman->ActiveChain().Genesis()->GetBlockHash();

        tip_height = m_node.chainman->ActiveChain().Height();

        tip_hash = m_node.chainman->ActiveChain().Tip()->GetBlockHash();

        max_height = tip_height - 2;

        max_hash = m_node.chainman->ActiveChain()[max_height]->GetBlockHash();

    }

    // A scan with max_height set stops exactly at max_height and does not

    // sync any blocks beyond it.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

            wallet.SetLastBlockProcessed(tip_height, tip_hash);

        }

        AddKey(wallet, coinbaseKey);

        WalletRescanReserver reserver(wallet);

        reserver.reserve();

        ScanResult result = wallet.Scanner().Scan(genesis_hash, /*start_height=*/0, max_height, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, ScanResult::SUCCESS);

        BOOST_CHECK(result.last_failed_block.IsNull());

        BOOST_CHECK_EQUAL(result.last_scanned_block, max_hash);

        BOOST_CHECK_EQUAL(*result.last_scanned_height, max_height);

        // One coinbase per block from height 1 through max_height.

        BOOST_CHECK_EQUAL(WITH_LOCK(wallet.cs_wallet, return wallet.mapWallet.size()), static_cast<size_t>(max_height));

    }

    // A single-block range (start == max_height == tip) scans exactly that

    // block.

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        {

            LOCK(wallet.cs_wallet);

            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

            wallet.SetLastBlockProcessed(tip_height, tip_hash);

        }

        AddKey(wallet, coinbaseKey);

        WalletRescanReserver reserver(wallet);

        reserver.reserve();

        ScanResult result = wallet.Scanner().Scan(tip_hash, tip_height, tip_height, reserver, /*save_progress=*/false);

        BOOST_CHECK_EQUAL(result.status, ScanResult::SUCCESS);

        BOOST_CHECK(result.last_failed_block.IsNull());

        BOOST_CHECK_EQUAL(result.last_scanned_block, tip_hash);

        BOOST_CHECK_EQUAL(*result.last_scanned_height, tip_height);

        BOOST_CHECK_EQUAL(WITH_LOCK(wallet.cs_wallet, return wallet.mapWallet.size()), 1U);

    }

}

BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_tip_extension, TestChain100Setup)

{

    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

    uint256 genesis_hash;

    int start_tip_height{0};

    {

        LOCK(wallet.cs_wallet);

        LOCK(Assert(m_node.chainman)->GetMutex());

        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

        start_tip_height = m_node.chainman->ActiveChain().Height();

        wallet.SetLastBlockProcessed(start_tip_height, m_node.chainman->ActiveChain().Tip()->GetBlockHash());

        genesis_hash = m_node.chainman->ActiveChain().Genesis()->GetBlockHash();

    }

    AddKey(wallet, coinbaseKey);

    // Connect a block while the scan is running (the handler fires on the

    // scanning thread as the scan starts) and advance the wallet's tip, as

    // the blockConnected notification would. The scan must pick up the new

    // tip instead of stopping at the height it started with.

    uint256 new_tip_hash;

    bool extended{false};

    auto handler = wallet.ShowProgress.connect([&](const std::string&, int) {

        if (extended) return;

        extended = true;

        CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));

        LOCK(wallet.cs_wallet);

        LOCK(Assert(m_node.chainman)->GetMutex());

        const CBlockIndex* new_tip = m_node.chainman->ActiveChain().Tip();

        new_tip_hash = new_tip->GetBlockHash();

        wallet.SetLastBlockProcessed(new_tip->nHeight, new_tip_hash);

    });

    WalletRescanReserver reserver(wallet);

    reserver.reserve();

    ScanResult result = wallet.Scanner().Scan(genesis_hash, /*start_height=*/0, /*max_height=*/{}, reserver, /*save_progress=*/false);

    handler.disconnect();

    BOOST_CHECK_EQUAL(result.status, ScanResult::SUCCESS);

    BOOST_CHECK_EQUAL(result.last_scanned_block, new_tip_hash);

    BOOST_CHECK_EQUAL(*result.last_scanned_height, start_tip_height + 1);

}

BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_no_progress_saved, TestChain100Setup)

{

    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

    uint256 genesis_hash, tip_hash;

    int max_height;

    {

        LOCK(wallet.cs_wallet);

        LOCK(Assert(m_node.chainman)->GetMutex());

        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

        tip_hash = m_node.chainman->ActiveChain().Tip()->GetBlockHash();

        wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), tip_hash);

        genesis_hash = m_node.chainman->ActiveChain().Genesis()->GetBlockHash();

        max_height = m_node.chainman->ActiveChain().Height() - 2;

    }

    AddKey(wallet, coinbaseKey);

    WalletRescanReserver reserver(wallet);

    // Advance the clock on every call so that every scanned block would be

    // eligible for a progress write if save_progress were set.

    std::chrono::steady_clock::time_point fake_time;

    reserver.setNow([&] { fake_time += 60s; return fake_time; });

    reserver.reserve();

    ScanResult result = wallet.Scanner().Scan(genesis_hash, /*start_height=*/0, max_height, reserver, /*save_progress=*/false);

    BOOST_CHECK_EQUAL(result.status, ScanResult::SUCCESS);

    // With save_progress=false the scan must not touch the wallet's best

    // block record: it still points at the tip written when the descriptor

    // was added, not at any block the scan visited.

    CBlockLocator locator;

    BOOST_CHECK(WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));

    BOOST_CHECK(!locator.IsNull());

    BOOST_CHECK_EQUAL(locator.vHave.front(), tip_hash);

}

BOOST_FIXTURE_TEST_CASE(rescan_from_time, TestChain100Setup)

{

    // Cap last block file size, and mine new block in a new block file.

    CBlockIndex* old_tip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());

    WITH_LOCK(::cs_main, m_node.chainman->m_blockman.GetBlockFileInfo(old_tip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);

    CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));

    CBlockIndex* new_tip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());

    // Prune the older block file.

    int file_number;

    {

        LOCK(cs_main);

        file_number = old_tip->GetBlockPos().nFile;

        Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);

    }

    m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});

    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

    {

        LOCK(wallet.cs_wallet);

        LOCK(Assert(m_node.chainman)->GetMutex());

        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();

    // Blocks before the prune point cannot be read: the returned timestamp

    // is moved past the last unreadable block, telling the caller from when

    // the rescan is actually complete.

    const int64_t genesis_time{WITH_LOCK(::cs_main, return m_node.chainman->ActiveChain().Genesis()->GetBlockTime())};

    BOOST_CHECK_EQUAL(wallet.Scanner().ScanFromTime(genesis_time, reserver),

                      WITH_LOCK(::cs_main, return old_tip->GetBlockTimeMax()) + TIMESTAMP_WINDOW + 1);

    bool scan_logged{false};

    DebugLogHelper scan_check{"Rescan started from block", [&](const std::string* s) {

        if (s) scan_logged = true;

        return false;

    }};

    // A timestamp past the tip requires no scanning and is returned unchanged.

    const int64_t future_time{WITH_LOCK(::cs_main, return new_tip->GetBlockTimeMax()) + TIMESTAMP_WINDOW + 1};

    BOOST_CHECK(!scan_logged);

    BOOST_CHECK_EQUAL(wallet.Scanner().ScanFromTime(future_time, reserver), future_time);

}

BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_missing_filter, TestChain100Setup)

{

    // Enable the block filter index but do not sync it: no filters are

    // available, so the scan must inspect every block rather than treat

    // the missing filters as misses and skip blocks.

    BOOST_REQUIRE(InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1_MiB, /*f_memory=*/true));

    BlockFilterIndex& filter_index{*Assert(GetBlockFilterIndex(BlockFilterType::BASIC))};

    BOOST_REQUIRE(filter_index.Init());

    {

        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());

        uint256 genesis_hash, tip_hash;

        int tip_height;

        {

            LOCK(wallet.cs_wallet);

            LOCK(Assert(m_node.chainman)->GetMutex());

            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

            genesis_hash = m_node.chainman->ActiveChain().Genesis()->GetBlockHash();

            tip_height = m_node.chainman->ActiveChain().Height();

            auto tip{m_node.chainman->ActiveChain().Tip()};

            tip_hash = tip->GetBlockHash();

            wallet.SetLastBlockProcessed(tip_height, tip_hash);

            BlockFilter filter;

            BOOST_REQUIRE(!filter_index.LookupFilter(tip, filter));

        }

        AddKey(wallet, coinbaseKey);

        WalletRescanReserver reserver(wallet);

        reserver.reserve();

        bool fast_scan_logged{false};

        DebugLogHelper scan_check{"fast variant using block filters", [&](const std::string* s) {

            if (s) fast_scan_logged = true;

            return false;

        }};

        ScanResult result = wallet.Scanner().Scan(genesis_hash, /*start_height=*/0, /*max_height=*/{}, reserver, /*save_progress=*/false);

        BOOST_REQUIRE(fast_scan_logged);

        BOOST_CHECK_EQUAL(result.status, ScanResult::SUCCESS);

        BOOST_CHECK(result.last_failed_block.IsNull());

        BOOST_CHECK_EQUAL(result.last_scanned_block, tip_hash);

        BOOST_CHECK_EQUAL(*result.last_scanned_height, tip_height);

        // One coinbase per block from height 1 through the tip.

        BOOST_CHECK_EQUAL(WITH_LOCK(wallet.cs_wallet, return wallet.mapWallet.size()), static_cast<size_t>(tip_height));

    }

    filter_index.Stop();

    BOOST_REQUIRE(DestroyBlockFilterIndex(BlockFilterType::BASIC));

}

//! Test the rescan that loading a wallet performs when the wallet is behind

//! the chain tip: it scans from the wallet's recorded best block - a

//! mid-chain start - with cs_wallet held.

BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_attach_chain, TestChain100Setup)

{

    // Do not wait for sqlite to flush data to disk to improve performance

    m_args.ForceSetArg("-unsafesqlitesync", "1");

    // Create a wallet owning the coinbases, and unload it at the current tip.

    WalletContext context;

    context.args = &m_args;

    context.chain = m_node.chain.get();

    auto wallet = TestCreateWallet(context);

    AddKey(*wallet, coinbaseKey);

    TestUnloadWallet(std::move(wallet));

    // Extend the chain while the wallet is not loaded.

    constexpr int NEW_BLOCKS{5};

    for (int i = 0; i < NEW_BLOCKS; ++i) {

        CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));

    }

    int tip_height;

    uint256 tip_hash;

    {

        LOCK(Assert(m_node.chainman)->GetMutex());

        tip_height = m_node.chainman->ActiveChain().Height();

        tip_hash = m_node.chainman->ActiveChain().Tip()->GetBlockHash();

    }

    // Loading the wallet must rescan the extension from the recorded best

    // block and find its coinbases.

    wallet = TestLoadWallet(context);

    {

        LOCK(wallet->cs_wallet);

        BOOST_CHECK_EQUAL(wallet->GetLastBlockHeight(), tip_height);

        BOOST_CHECK_EQUAL(wallet->GetLastBlockHash(), tip_hash);

        // The extension's coinbases plus the one of the recorded best block:

        // the load rescan starts mid-chain, at that block inclusive.

        BOOST_CHECK_EQUAL(wallet->mapWallet.size(), static_cast<size_t>(NEW_BLOCKS + 1));

    }

    TestUnloadWallet(std::move(wallet));

}

// This test verifies that wallet settings can be added and removed

// concurrently, ensuring no race conditions occur during either process.

BOOST_FIXTURE_TEST_CASE(write_wallet_settings_concurrently, TestingSetup)

{

    auto chain = m_node.chain.get();

    const auto NUM_WALLETS{5};

    // Since we're counting the number of wallets, ensure we start without any.

    BOOST_REQUIRE(chain->getRwSetting("wallet").isNull());

    const auto& check_concurrent_wallet = [&](const auto& settings_function, int num_expected_wallets) {

        std::vector<std::thread> threads;

        threads.reserve(NUM_WALLETS);

        for (auto i{0}; i < NUM_WALLETS; ++i) threads.emplace_back(settings_function, i);

        for (auto& t : threads) t.join();

        auto wallets = chain->getRwSetting("wallet");

        BOOST_CHECK_EQUAL(wallets.getValues().size(), num_expected_wallets);

    };

wallet_tests.cpp:_ZZN6wallet12wallet_tests34write_wallet_settings_concurrently11test_methodEvENK3$_1clIZNS1_11test_methodEvE3$_0EEDaRKT_i

Line

Count

Source

715

1

    const auto& check_concurrent_wallet = [&](const auto& settings_function, int num_expected_wallets) {

716

1

        std::vector<std::thread> threads;

717

1

        threads.reserve(NUM_WALLETS);

718

6

        for (auto i{0}; i < NUM_WALLETS; ++i) threads.emplace_back(settings_function, i);

719

5

        for (auto& t : threads) t.join();

720

721

1

        auto wallets = chain->getRwSetting("wallet");

722

        BOOST_CHECK_EQUAL(wallets.getValues().size(), num_expected_wallets);

723

1

    };

wallet_tests.cpp:_ZZN6wallet12wallet_tests34write_wallet_settings_concurrently11test_methodEvENK3$_1clIZNS1_11test_methodEvE3$_2EEDaRKT_i

Line

Count

Source

715

1

    const auto& check_concurrent_wallet = [&](const auto& settings_function, int num_expected_wallets) {

716

1

        std::vector<std::thread> threads;

717

1

        threads.reserve(NUM_WALLETS);

718

6

        for (auto i{0}; i < NUM_WALLETS; ++i) threads.emplace_back(settings_function, i);

719

5

        for (auto& t : threads) t.join();

720

721

1

        auto wallets = chain->getRwSetting("wallet");

722

        BOOST_CHECK_EQUAL(wallets.getValues().size(), num_expected_wallets);

723

1

    };

    // Add NUM_WALLETS wallets concurrently, ensure we end up with NUM_WALLETS stored.

    check_concurrent_wallet([&chain](int i) {

        Assert(AddWalletSetting(*chain, strprintf("wallet_%d", i)));

    },

                            /*num_expected_wallets=*/NUM_WALLETS);

    // Remove NUM_WALLETS wallets concurrently, ensure we end up with 0 wallets.

    check_concurrent_wallet([&chain](int i) {

        Assert(RemoveWalletSetting(*chain, strprintf("wallet_%d", i)));

    },

                            /*num_expected_wallets=*/0);

}

static int64_t AddTx(ChainstateManager& chainman, CWallet& wallet, uint32_t lockTime, std::chrono::seconds mock_time, int64_t blockTime)

{

    CMutableTransaction tx;

    TxState state = TxStateInactive{};

    tx.nLockTime = lockTime;

    FakeNodeClock clock{mock_time};

    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, 100s, 120), 100);

    // Test that updating existing transaction does not change smart time.

    BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 1, 200s, 220), 100);

    // New transaction should use clock time if there's no block time.

    BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 2, 300s, 0), 300);

    // New transaction should use block time if lower than clock time.

    BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 3, 420s, 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, 500s, 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, 50s, 600), 300);

}

void TestLoadWallet(const std::string& name, DatabaseFormat format, std::function<void(std::shared_ptr<CWallet>)> f)

{

    node::NodeContext node;

    auto chain{interfaces::MakeChain(node)};

    DatabaseOptions options;

    options.require_format = format;

    DatabaseStatus status;

    bilingual_str error;

    std::vector<bilingual_str> warnings;

    auto database{MakeWalletDatabase(name, options, status, error)};

    auto wallet{std::make_shared<CWallet>(chain.get(), "", std::move(database))};

    BOOST_CHECK_EQUAL(wallet->PopulateWalletFromDB(error, warnings), DBErrors::LOAD_OK);

    WITH_LOCK(wallet->cs_wallet, f(wallet));

}

BOOST_FIXTURE_TEST_CASE(LoadReceiveRequests, TestingSetup)

{

    for (DatabaseFormat format : DATABASE_FORMATS) {

        const std::string name{strprintf("receive-requests-%i", format)};

        TestLoadWallet(name, format, [](std::shared_ptr<CWallet> wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet->cs_wallet) {

            BOOST_CHECK(!wallet->IsAddressPreviouslySpent(PKHash()));

            WalletBatch batch{wallet->GetDatabase()};

            BOOST_CHECK(batch.WriteAddressPreviouslySpent(PKHash(), true));

            BOOST_CHECK(batch.WriteAddressPreviouslySpent(ScriptHash(), true));

            BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, PKHash(), "0", "val_rr00"));

            BOOST_CHECK(wallet->EraseAddressReceiveRequest(batch, PKHash(), "0"));

            BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, PKHash(), "1", "val_rr10"));

            BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, PKHash(), "1", "val_rr11"));

            BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, ScriptHash(), "2", "val_rr20"));

        });

        TestLoadWallet(name, format, [](std::shared_ptr<CWallet> wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet->cs_wallet) {

            BOOST_CHECK(wallet->IsAddressPreviouslySpent(PKHash()));

            BOOST_CHECK(wallet->IsAddressPreviouslySpent(ScriptHash()));

            auto requests = wallet->GetAddressReceiveRequests();

            auto erequests = {"val_rr11", "val_rr20"};

            BOOST_CHECK_EQUAL_COLLECTIONS(requests.begin(), requests.end(), std::begin(erequests), std::end(erequests));

            RunWithinTxn(wallet->GetDatabase(), /*process_desc=*/"test", [](WalletBatch& batch){

                BOOST_CHECK(batch.WriteAddressPreviouslySpent(PKHash(), false));

                BOOST_CHECK(batch.EraseAddressData(ScriptHash()));

                return true;

            });

        });

        TestLoadWallet(name, format, [](std::shared_ptr<CWallet> wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet->cs_wallet) {

            BOOST_CHECK(!wallet->IsAddressPreviouslySpent(PKHash()));

            BOOST_CHECK(!wallet->IsAddressPreviouslySpent(ScriptHash()));

            auto requests = wallet->GetAddressReceiveRequests();

            auto erequests = {"val_rr11"};

            BOOST_CHECK_EQUAL_COLLECTIONS(requests.begin(), requests.end(), std::begin(erequests), std::end(erequests));

        });

    }

}

class ListCoinsTestingSetup : public TestChain100Setup

{

public:

    ListCoinsTestingSetup()

    {

        CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));

        wallet = CreateSyncedWallet(*m_node.chain, WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain()), coinbaseKey);

    }

    ~ListCoinsTestingSetup()

    {

        wallet.reset();

    }

    CWalletTx& AddTx(CRecipient recipient)

    {

        CTransactionRef tx;

        CCoinControl dummy;

        {

            auto res = CreateTransaction(*wallet, {recipient}, /*change_pos=*/std::nullopt, dummy);

            BOOST_CHECK(res);

            tx = res->tx;

        }

        wallet->CommitTransaction(tx);

        CMutableTransaction blocktx;

        {

            LOCK(wallet->cs_wallet);

            blocktx = CMutableTransaction(*wallet->mapWallet.at(tx->GetHash()).GetTx());

        }

        CreateAndProcessBlock({CMutableTransaction(blocktx)}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));

        LOCK(wallet->cs_wallet);

        LOCK(Assert(m_node.chainman)->GetMutex());

        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, WITH_LOCK(wallet->cs_wallet, return AvailableCoins(*wallet).GetTotalAmount()));

    // 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{PubKeyDestination{{}}, 1 * COIN, /*subtract_fee=*/false});

    {

        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);

        BOOST_CHECK_EQUAL(AvailableCoins(*wallet).Size(), 2U);

    }

    for (const auto& group : list) {

        for (const auto& coin : group.second) {

            LOCK(wallet->cs_wallet);

            wallet->LockCoin(coin.outpoint, /*persist=*/false);

        }

    }

    {

        LOCK(wallet->cs_wallet);

        BOOST_CHECK_EQUAL(AvailableCoins(*wallet).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);

}

void TestCoinsResult(ListCoinsTest& context, OutputType out_type, CAmount amount,

                     std::map<OutputType, size_t>& expected_coins_sizes)

{

    LOCK(context.wallet->cs_wallet);

    util::Result<CTxDestination> dest = Assert(context.wallet->GetNewDestination(out_type, ""));

    CWalletTx& wtx = context.AddTx(CRecipient{*dest, amount, /*fSubtractFeeFromAmount=*/true});

    CoinFilterParams filter;

    filter.skip_locked = false;

    CoinsResult available_coins = AvailableCoins(*context.wallet, nullptr, std::nullopt, filter);

    // Lock outputs so they are not spent in follow-up transactions

    for (uint32_t i = 0; i < wtx.GetTx()->vout.size(); i++) context.wallet->LockCoin({wtx.GetHash(), i}, /*persist=*/false);

    for (const auto& [type, size] : expected_coins_sizes) BOOST_CHECK_EQUAL(size, available_coins.coins[type].size());

}

BOOST_FIXTURE_TEST_CASE(BasicOutputTypesTest, ListCoinsTest)

{

    std::map<OutputType, size_t> expected_coins_sizes;

    for (const auto& out_type : OUTPUT_TYPES) { expected_coins_sizes[out_type] = 0U; }

    // Verify our wallet has one usable coinbase UTXO before starting

    // This UTXO is a P2PK, so it should show up in the Other bucket

    expected_coins_sizes[OutputType::UNKNOWN] = 1U;

    CoinsResult available_coins = WITH_LOCK(wallet->cs_wallet, return AvailableCoins(*wallet));

    BOOST_CHECK_EQUAL(available_coins.Size(), expected_coins_sizes[OutputType::UNKNOWN]);

    BOOST_CHECK_EQUAL(available_coins.coins[OutputType::UNKNOWN].size(), expected_coins_sizes[OutputType::UNKNOWN]);

    // We will create a self transfer for each of the OutputTypes and

    // verify it is put in the correct bucket after running GetAvailablecoins

    //

    // For each OutputType, We expect 2 UTXOs in our wallet following the self transfer:

    //   1. One UTXO as the recipient

    //   2. One UTXO from the change, due to payment address matching logic

    for (const auto& out_type : OUTPUT_TYPES) {

        if (out_type == OutputType::UNKNOWN) continue;

        expected_coins_sizes[out_type] = 2U;

        TestCoinsResult(*this, out_type, 1 * COIN, expected_coins_sizes);

    }

}

BOOST_FIXTURE_TEST_CASE(wallet_disableprivkeys, TestChain100Setup)

{

    const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());

    LOCK(wallet->cs_wallet);

    wallet->SetWalletFlag(WALLET_FLAG_DESCRIPTORS);

    wallet->SetWalletFlag(WALLET_FLAG_DISABLE_PRIVATE_KEYS);

    BOOST_CHECK(!wallet->GetNewDestination(OutputType::BECH32, ""));

}

// 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 = GenerateRandomKey();

    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);