// Copyright (c) 2021-2022 The Bitcoin Core developers

// Distributed under the MIT software license, see the accompanying

// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_WALLET_TEST_UTIL_H

#define BITCOIN_WALLET_TEST_UTIL_H

#include <bitcoin-build-config.h> // IWYU pragma: keep

#include <addresstype.h>

#include <wallet/db.h>

#include <wallet/scriptpubkeyman.h>

#include <memory>

class ArgsManager;

class CChain;

class CKey;

enum class OutputType;

namespace interfaces {

class Chain;

} // namespace interfaces

namespace wallet {

class CWallet;

class WalletDatabase;

struct WalletContext;

static const DatabaseFormat DATABASE_FORMATS[] = {

       DatabaseFormat::SQLITE,

#ifdef USE_BDB

       DatabaseFormat::BERKELEY,

#endif

};

const std::string ADDRESS_BCRT1_UNSPENDABLE = "bcrt1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq3xueyj";

std::unique_ptr<CWallet> CreateSyncedWallet(interfaces::Chain& chain, CChain& cchain, const CKey& key);

std::shared_ptr<CWallet> TestLoadWallet(WalletContext& context);

std::shared_ptr<CWallet> TestLoadWallet(std::unique_ptr<WalletDatabase> database, WalletContext& context, uint64_t create_flags);

void TestUnloadWallet(std::shared_ptr<CWallet>&& wallet);

// Creates a copy of the provided database

std::unique_ptr<WalletDatabase> DuplicateMockDatabase(WalletDatabase& database);

/** Returns a new encoded destination from the wallet (hardcoded to BECH32) */

std::string getnewaddress(CWallet& w);

/** Returns a new destination, of an specific type, from the wallet */

CTxDestination getNewDestination(CWallet& w, OutputType output_type);

using MockableData = std::map<SerializeData, SerializeData, std::less<>>;

class MockableCursor: public DatabaseCursor

{

public:

    MockableData::const_iterator m_cursor;

    MockableData::const_iterator m_cursor_end;

    bool m_pass;

    explicit MockableCursor(const MockableData& records, bool pass) : m_cursor(records.begin()), m_cursor_end(records.end()), m_pass(pass) {}

    MockableCursor(const MockableData& records, bool pass, Span<const std::byte> prefix);

    ~MockableCursor() = default;

    Status Next(DataStream& key, DataStream& value) override;

};

class MockableBatch : public DatabaseBatch

{

private:

    MockableData& m_records;

    bool m_pass;

    bool ReadKey(DataStream&& key, DataStream& value) override;

    bool WriteKey(DataStream&& key, DataStream&& value, bool overwrite=true) override;

    bool EraseKey(DataStream&& key) override;

    bool HasKey(DataStream&& key) override;

    bool ErasePrefix(Span<const std::byte> prefix) override;

public:

    explicit MockableBatch(MockableData& records, bool pass) : m_records(records), m_pass(pass) {}

    ~MockableBatch() = default;

    void Flush() override {}

    void Close() override {}

    std::unique_ptr<DatabaseCursor> GetNewCursor() override

    {

        return std::make_unique<MockableCursor>(m_records, m_pass);

    }

    std::unique_ptr<DatabaseCursor> GetNewPrefixCursor(Span<const std::byte> prefix) override {

        return std::make_unique<MockableCursor>(m_records, m_pass, prefix);

    }

    bool TxnBegin() override { return m_pass; }

    bool TxnCommit() override { return m_pass; }

    bool TxnAbort() override { return m_pass; }

    bool HasActiveTxn() override { return false; }

};

/** A WalletDatabase whose contents and return values can be modified as needed for testing

 **/

class MockableDatabase : public WalletDatabase

{

public:

    MockableData m_records;

    bool m_pass{true};

    MockableDatabase(MockableData records = {}) : WalletDatabase(), m_records(records) {}

    ~MockableDatabase() = default;

    void Open() override {}

    void AddRef() override {}

    void RemoveRef() override {}

    bool Rewrite(const char* pszSkip=nullptr) override { return m_pass; }

    bool Backup(const std::string& strDest) const override { return m_pass; }

    void Flush() override {}

    void Close() override {}

    bool PeriodicFlush() override { return m_pass; }

    void IncrementUpdateCounter() override {}

    void ReloadDbEnv() override {}

    std::string Filename() override { return "mockable"; }

    std::string Format() override { return "mock"; }

    std::unique_ptr<DatabaseBatch> MakeBatch(bool flush_on_close = true) override { return std::make_unique<MockableBatch>(m_records, m_pass); }

};

std::unique_ptr<WalletDatabase> CreateMockableWalletDatabase(MockableData records = {});

MockableDatabase& GetMockableDatabase(CWallet& wallet);

ScriptPubKeyMan* CreateDescriptor(CWallet& keystore, const std::string& desc_str, const bool success);

} // namespace wallet

#endif // BITCOIN_WALLET_TEST_UTIL_H