// 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/wallet.h>

#include <array>

#include <cstddef>

#include <cstdint>

#include <future>

#include <limits>

#include <memory>

#include <optional>

#include <stdexcept>

#include <string>

#include <utility>

#include <vector>

#include <addresstype.h>

#include <chain.h>

#include <consensus/tx_verify.h>

#include <consensus/validation.h>

#include <interfaces/chain.h>

#include <key_io.h>

#include <node/types.h>

#include <policy/feerate.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 <test/util/time.h>

#include <util/check.h>

#include <util/strencodings.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>

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 bool BroadcastTestSimpleSpend(interfaces::Chain& chain, ChainstateManager& chainman, const CMutableTransaction& tx, std::string& error)

{

    const auto tx_ref{MakeTransactionRef(tx)};

    const auto tx_sigops = WITH_LOCK(::cs_main, return GetTransactionSigOpCost(

                                                    *tx_ref, chainman.ActiveChainstate().CoinsTip(), STANDARD_SCRIPT_VERIFY_FLAGS));

    const auto tx_vsize{GetVirtualTransactionSize(*tx_ref, tx_sigops, nBytesPerSigOp)};

    const auto tx_feerate{CFeeRate{DEFAULT_TRANSACTION_MAXFEE, static_cast<int32_t>(tx_vsize)}};

    // TestSimpleSpend pays a high fee; use a limit just above its feerate.

    const auto tx_feerate_limit{CFeeRate{tx_feerate.GetFeePerK() + 1}};

    return chain.broadcastTransaction(tx_ref, DEFAULT_TRANSACTION_MAXFEE, tx_feerate_limit, node::TxBroadcast::MEMPOOL_NO_BROADCAST, error);

}

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>{std::numeric_limits<int64_t>::max(), 0}, "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);

    }

}

namespace {

struct EncryptionFailureSetup : TestingSetup {

    WalletContext context;

    FaultInjectingDatabase* fail_db{nullptr};

    std::shared_ptr<CWallet> wallet;

    FakeNodeClock clock; // Frozen time makes EncryptMasterKey use the default KDF iteration count

    EncryptionFailureSetup()

    {

        context.args = &m_args;

        m_args.ForceSetArg("-keypool", "1"); // Failure injection does not depend on keypool depth

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

        RecreateWallet(WALLET_FLAG_DESCRIPTORS);

    }

    void RecreateWallet(uint64_t create_flags)

    {

        if (wallet) TestUnloadWallet(std::move(wallet));

        auto database{std::make_unique<FaultInjectingDatabase>()};

        fail_db = database.get();

        wallet = TestCreateWallet(std::move(database), context, create_flags);

    }

    ~EncryptionFailureSetup() { TestUnloadWallet(std::move(wallet)); }

};

} // namespace

BOOST_FIXTURE_TEST_CASE(encrypt_wallet_master_key_write_failure, EncryptionFailureSetup)

{

    AddKey(*wallet, GenerateRandomKey());

    fail_db->FailNextWrite(DBKeys::MASTER_KEY); // The injected failure affects only the first attempt

    for (bool success : {false, true}) {

        BOOST_CHECK_EQUAL(wallet->EncryptWallet("passphrase"), success);

        BOOST_CHECK_EQUAL(wallet->HasEncryptionKeys(), success);

        BOOST_CHECK_EQUAL(wallet->HaveCryptedKeys(), success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::MASTER_KEY), success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORKEY), !success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORCKEY), success);

    }

}

BOOST_FIXTURE_TEST_CASE(encrypt_wallet_commit_failure, EncryptionFailureSetup)

{

    AddKey(*wallet, GenerateRandomKey());

    fail_db->FailNextCommit(); // The injected failure affects only the first attempt

    test_only_CheckFailuresAreExceptionsNotAborts mock_checks; // Keep abort regressions observable

    BOOST_CHECK(!wallet->EncryptWallet("passphrase"));

    BOOST_CHECK(!wallet->HasEncryptionKeys());

    BOOST_CHECK(!wallet->HaveCryptedKeys());

    BOOST_CHECK(!fail_db->HasRecordType(DBKeys::MASTER_KEY));

    BOOST_CHECK( fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORKEY));

    BOOST_CHECK(!fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORCKEY));

    BOOST_CHECK( wallet->EncryptWallet("passphrase"));

    BOOST_CHECK( wallet->HasEncryptionKeys());

    BOOST_CHECK( wallet->HaveCryptedKeys());

    BOOST_CHECK( fail_db->HasRecordType(DBKeys::MASTER_KEY));

    BOOST_CHECK(!fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORKEY));

    BOOST_CHECK( fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORCKEY));

}

BOOST_FIXTURE_TEST_CASE(encrypt_wallet_descriptor_key_write_failure, EncryptionFailureSetup)

{

    AddKey(*wallet, GenerateRandomKey());

    fail_db->FailNextWrite(DBKeys::WALLETDESCRIPTORCKEY, /*match_skip_count=*/1); // Only one write fails

    for (bool success : {false, true}) {

        BOOST_CHECK_EQUAL(wallet->EncryptWallet("passphrase"), success);

        BOOST_CHECK_EQUAL(wallet->HasEncryptionKeys(), success);

        BOOST_CHECK_EQUAL(wallet->HaveCryptedKeys(), success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::MASTER_KEY), success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORKEY), !success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORCKEY), success);

    }

}

BOOST_FIXTURE_TEST_CASE(encrypt_wallet_descriptor_key_erase_failure, EncryptionFailureSetup)

{

    AddKey(*wallet, GenerateRandomKey());

    fail_db->FailNextErase(DBKeys::WALLETDESCRIPTORKEY); // Only one erase fails

    for (bool success : {false, true}) {

        BOOST_CHECK_EQUAL(wallet->EncryptWallet("passphrase"), success);

        BOOST_CHECK_EQUAL(wallet->HasEncryptionKeys(), success);

        BOOST_CHECK_EQUAL(wallet->HaveCryptedKeys(), success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::MASTER_KEY), success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORKEY), !success);

        BOOST_CHECK_EQUAL(fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORCKEY), success);

    }

}

BOOST_FIXTURE_TEST_CASE(change_passphrase_master_key_write_failure, EncryptionFailureSetup)

{

    AddKey(*wallet, GenerateRandomKey());

    BOOST_REQUIRE(wallet->EncryptWallet("old_pass"));

    BOOST_REQUIRE(wallet->IsLocked());

    const auto master_key_record{fail_db->GetRecordValue(DBKeys::MASTER_KEY)};

    BOOST_REQUIRE(master_key_record);

    fail_db->FailNextWrite(DBKeys::MASTER_KEY); // The injected failure affects only the first attempt

    const auto changed{wallet->ChangeWalletPassphrase("old_pass", "new_pass")};

    BOOST_REQUIRE(!changed);

    BOOST_CHECK_EQUAL(changed.error().code, WalletErrorCode::GenericError);

    BOOST_CHECK_EQUAL(changed.error().message.original, "Error: Writing the new encryption key to the wallet database failed");

    BOOST_CHECK( wallet->IsLocked());

    BOOST_CHECK( fail_db->GetRecordValue(DBKeys::MASTER_KEY) == master_key_record);

    BOOST_CHECK( wallet->Unlock("old_pass"));

    wallet->Lock();

    BOOST_CHECK(!wallet->Unlock("new_pass"));

    BOOST_CHECK( wallet->ChangeWalletPassphrase("old_pass", "new_pass"));

    BOOST_CHECK( wallet->IsLocked());

    BOOST_CHECK( fail_db->GetRecordValue(DBKeys::MASTER_KEY) != master_key_record);

    BOOST_CHECK( wallet->Unlock("new_pass"));

    wallet->Lock();

    const auto unlocked{wallet->Unlock("old_pass")};

    BOOST_REQUIRE(!unlocked);

    BOOST_CHECK_EQUAL(unlocked.error().code, WalletErrorCode::PassphraseIncorrect);

    BOOST_CHECK_EQUAL(unlocked.error().message.original, "Error: The wallet passphrase entered was incorrect.");

}

BOOST_FIXTURE_TEST_CASE(add_encrypted_descriptor_key_without_plaintext_record, EncryptionFailureSetup)

{

    RecreateWallet(WALLET_FLAG_DESCRIPTORS | WALLET_FLAG_BLANK_WALLET);

    BOOST_REQUIRE(wallet->EncryptWallet("passphrase"));

    BOOST_REQUIRE(wallet->Unlock("passphrase"));

    AddKey(*wallet, GenerateRandomKey());

    BOOST_CHECK( wallet->HaveCryptedKeys());

    BOOST_CHECK( fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORCKEY));

    BOOST_CHECK(!fail_db->HasRecordType(DBKeys::WALLETDESCRIPTORKEY));

}

BOOST_FIXTURE_TEST_CASE(add_descriptor_key_database_failure, EncryptionFailureSetup)

{

    enum class Failure { PlaintextWrite, EncryptedWrite, Erase, Commit };

    for (auto failure : {Failure::PlaintextWrite, Failure::EncryptedWrite, Failure::Erase, Failure::Commit}) {

        const bool encrypted{failure != Failure::PlaintextWrite};

        RecreateWallet(WALLET_FLAG_DESCRIPTORS | WALLET_FLAG_BLANK_WALLET);

        CKey key{GenerateRandomKey()};

        // Add a public descriptor first so the private-key update exercises an existing live manager

        auto* spkm{CreateDescriptor(*wallet, strprintf("combo(%s)", HexStr(key.GetPubKey())), /*success=*/true)};

        WalletDescriptor descriptor{WITH_LOCK(spkm->cs_desc_man, return spkm->GetWalletDescriptor())};

        FlatSigningProvider provider;

        provider.keys.emplace(key.GetPubKey().GetID(), key);

        auto add_key{[&] {

            LOCK(wallet->cs_wallet);

            return wallet->AddWalletDescriptor(descriptor, provider, /*label=*/"", /*internal=*/false);

        }};

        auto has_key{[&] {

            LOCK(wallet->cs_wallet);

            return wallet->GetKey(key.GetPubKey().GetID()).has_value();

        }};

        if (encrypted) {

            BOOST_REQUIRE(wallet->EncryptWallet("passphrase"));

            BOOST_REQUIRE(wallet->Unlock("passphrase"));

        }

        BOOST_CHECK(!has_key());

        const std::string record_type{encrypted ? DBKeys::WALLETDESCRIPTORCKEY : DBKeys::WALLETDESCRIPTORKEY};

        if (failure == Failure::Erase) {

            fail_db->FailNextErase(DBKeys::WALLETDESCRIPTORKEY);

        } else if (failure == Failure::Commit) {

            fail_db->FailNextCommit();

        } else {

            fail_db->FailNextWrite(record_type);

        }

        BOOST_CHECK_EXCEPTION((void)add_key(), std::runtime_error, HasReason{"UpdateWithSigningProvider: writing descriptor private key failed"});

        BOOST_CHECK(!has_key());

        BOOST_CHECK(!fail_db->HasRecordType(record_type));

        BOOST_CHECK( add_key());

        BOOST_CHECK( has_key());

        BOOST_CHECK( fail_db->HasRecordType(record_type));

    }

}

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

    }

}

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

334

1

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

335

1

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

336

1

        threads.reserve(NUM_WALLETS);

337

6

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

338

5

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

339

340

1

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

341

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

342

1

    };

wallet_tests.cpp:_ZZN6wallet12wallet_tests34write_wallet_settings_concurrently11test_methodEvENK3$_1clIZNS1_11test_methodEvE3$_2EEDaRKT_i

Line

Count

Source

334

1

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

335

1

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

336

1

        threads.reserve(NUM_WALLETS);

337

6

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

338

5

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

339

340

1

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

341

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

342

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, BasicTestingSetup)

{

    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;

    BOOST_CHECK(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, BasicTestingSetup)

{

    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;

    VectorWriter vw{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{malformed_record};

    std::optional<WalletDescriptor> w_desc;

    BOOST_CHECK_EXCEPTION(w_desc.emplace(WalletDescriptor::FromStream(deserialize, vr)), std::ios_base::failure, malformed_descriptor);

}

//! Test CWallet::CreateNew() 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 = TestCreateWallet(context);

    CKey key = GenerateRandomKey();

    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;

    m_node.validation_signals->CallFunctionInValidationInterfaceQueue([&promise] {

        promise.get_future().wait();

    });

    std::string error;

    m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()), /*sync=*/false).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()), /*sync=*/false).vtx[0]);

    auto mempool_tx = TestSimpleSpend(*m_coinbase_txns[1], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));

    BOOST_CHECK(BroadcastTestSimpleSpend(*m_node.chain, *Assert(m_node.chainman), mempool_tx, error));

    // Reload wallet and make sure new transactions are detected despite events

    // being blocked

    // Loading will also ask for current mempool transactions

    wallet = TestLoadWallet(context);

    BOOST_CHECK(rescan_completed);

    // AddToWallet events for block_tx and mempool_tx (x2)

    BOOST_CHECK_EQUAL(addtx_count, 3);

    {

        LOCK(wallet->cs_wallet);

        BOOST_CHECK(wallet->mapWallet.contains(block_tx.GetHash()));

        BOOST_CHECK(wallet->mapWallet.contains(mempool_tx.GetHash()));

    }

    // Unblock notification queue and make sure stale blockConnected and

    // transactionAddedToMempool events are processed

    promise.set_value();

    m_node.validation_signals->SyncWithValidationInterfaceQueue();

    // AddToWallet events for block_tx and mempool_tx events are counted a

    // second time as the notification queue is processed

    BOOST_CHECK_EQUAL(addtx_count, 5);

    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(BroadcastTestSimpleSpend(*m_node.chain, *Assert(m_node.chainman), mempool_tx, error));

            m_node.validation_signals->SyncWithValidationInterfaceQueue();

        });

    wallet = TestLoadWallet(context);

    // Since mempool transactions are requested at the end of loading, there will

    // be 2 additional AddToWallet calls, one from the previous test, and a duplicate for mempool_tx

    BOOST_CHECK_EQUAL(addtx_count, 2 + 2);

    {

        LOCK(wallet->cs_wallet);

        BOOST_CHECK(wallet->mapWallet.contains(block_tx.GetHash()));

        BOOST_CHECK(wallet->mapWallet.contains(mempool_tx.GetHash()));

    }

    TestUnloadWallet(std::move(wallet));

}

BOOST_FIXTURE_TEST_CASE(CreateWalletWithoutChain, BasicTestingSetup)

{

    WalletContext context;

    context.args = &m_args;

    auto wallet = TestCreateWallet(context);

    BOOST_CHECK(wallet);

    WaitForDeleteWallet(std::move(wallet));

}

BOOST_FIXTURE_TEST_CASE(RemoveTxs, TestChain100Setup)

{

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

    WalletContext context;

    context.args = &m_args;

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

    auto wallet = TestCreateWallet(context);

    CKey key = GenerateRandomKey();

    AddKey(*wallet, key);

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

    m_node.validation_signals->SyncWithValidationInterfaceQueue();

    {

        auto block_hash = block_tx.GetHash();

        auto prev_tx = m_coinbase_txns[0];

        LOCK(wallet->cs_wallet);

        BOOST_CHECK(wallet->HasWalletSpend(prev_tx));

        BOOST_CHECK(wallet->mapWallet.contains(block_hash));

        std::vector<Txid> vHashIn{ block_hash };

        BOOST_CHECK(wallet->RemoveTxs(vHashIn));

        BOOST_CHECK(!wallet->HasWalletSpend(prev_tx));

        BOOST_CHECK(!wallet->mapWallet.contains(block_hash));

    }

    TestUnloadWallet(std::move(wallet));

}

BOOST_AUTO_TEST_SUITE_END()

} // namespace wallet