// Copyright (c) 2009-2010 Satoshi Nakamoto

// Copyright (c) 2009-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.

#ifndef BITCOIN_WALLET_WALLETDB_H

#define BITCOIN_WALLET_WALLETDB_H

#include <key.h>

#include <primitives/transaction.h>

#include <primitives/transaction_identifier.h>

#include <script/sign.h>

#include <wallet/db.h>

#include <wallet/walletutil.h>

#include <cstdint>

#include <string>

#include <unordered_set>

#include <vector>

class CScript;

class uint160;

class uint256;

struct CBlockLocator;

namespace wallet {

class CMasterKey;

class CWallet;

class CWalletTx;

struct WalletContext;

// Logs information about the database, including available engines, features, and other capabilities

void LogDBInfo();

/**

 * Overview of wallet database classes:

 *

 * - WalletBatch is an abstract modifier object for the wallet database, and encapsulates a database

 *   batch update as well as methods to act on the database. It should be agnostic to the database implementation.

 */

/** Error statuses for the wallet database.

 * Values are in order of severity. When multiple errors occur, the most severe (highest value) will be returned.

 */

enum class DBErrors : int

{

    LOAD_OK = 0,

    NEED_RESCAN = 1,

    EXTERNAL_SIGNER_SUPPORT_REQUIRED = 3,

    NONCRITICAL_ERROR = 4,

    TOO_NEW = 5,

    UNKNOWN_DESCRIPTOR = 6,

    LOAD_FAIL = 7,

    UNEXPECTED_LEGACY_ENTRY = 8,

    LEGACY_WALLET = 9,

    CORRUPT = 10,

};

namespace DBKeys {

extern const std::string ACENTRY;

extern const std::string ACTIVEEXTERNALSPK;

extern const std::string ACTIVEINTERNALSPK;

extern const std::string BESTBLOCK;

extern const std::string BESTBLOCK_NOMERKLE;

extern const std::string CRYPTED_KEY;

extern const std::string CSCRIPT;

extern const std::string DEFAULTKEY;

extern const std::string DESTDATA;

extern const std::string FLAGS;

extern const std::string HDCHAIN;

extern const std::string KEY;

extern const std::string KEYMETA;

extern const std::string LOCKED_UTXO;

extern const std::string MASTER_KEY;

extern const std::string MINVERSION;

extern const std::string NAME;

extern const std::string OLD_KEY;

extern const std::string ORDERPOSNEXT;

extern const std::string POOL;

extern const std::string PURPOSE;

extern const std::string SETTINGS;

extern const std::string TX;

extern const std::string WTX_VARIANT;

extern const std::string VERSION;

extern const std::string WALLETDESCRIPTOR;

extern const std::string WALLETDESCRIPTORCKEY;

extern const std::string WALLETDESCRIPTORKEY;

extern const std::string WATCHMETA;

extern const std::string WATCHS;

// Keys in this set pertain only to legacy wallets and are removed during migration to descriptors.

extern const std::unordered_set<std::string> LEGACY_TYPES;

} // namespace DBKeys

/* simple HD chain data model */

class CHDChain

{

public:

    uint32_t nExternalChainCounter;

    uint32_t nInternalChainCounter;

    CKeyID seed_id; //!< seed hash160

    static constexpr int VERSION_HD_BASE{1};

    static constexpr int VERSION_HD_CHAIN_SPLIT{2};

    static constexpr int CURRENT_VERSION{VERSION_HD_CHAIN_SPLIT};

    int nVersion;

    CHDChain() { SetNull(); }

    SERIALIZE_METHODS(CHDChain, obj)

    {

        READWRITE(obj.nVersion, obj.nExternalChainCounter, obj.seed_id);

        if (obj.nVersion >= VERSION_HD_CHAIN_SPLIT) {

  Branch (113:13): [True: 0, False: 0]

            READWRITE(obj.nInternalChainCounter);

        }

    }

    void SetNull()

    {

        nVersion = CHDChain::CURRENT_VERSION;

        nExternalChainCounter = 0;

        nInternalChainCounter = 0;

        seed_id.SetNull();

    }

    bool operator==(const CHDChain& chain) const

    {

        return seed_id == chain.seed_id;

    }

    bool operator<(const CHDChain& chain) const

    {

        return seed_id < chain.seed_id;

    }

};

class CKeyMetadata

{

public:

    static constexpr int VERSION_BASIC{1};

    static constexpr int VERSION_WITH_HDDATA{10};

    static constexpr int VERSION_WITH_KEY_ORIGIN{12};

    static constexpr int CURRENT_VERSION{VERSION_WITH_KEY_ORIGIN};

    int nVersion;

    int64_t nCreateTime; // 0 means unknown

    std::string hdKeypath; //optional HD/bip32 keypath. Still used to determine whether a key is a seed. Also kept for backwards compatibility

    CKeyID hd_seed_id; //id of the HD seed used to derive this key

    KeyOriginInfo key_origin; // Key origin info with path and fingerprint

    bool has_key_origin = false; //!< Whether the key_origin is useful

    CKeyMetadata()

    {

        SetNull();

    }

    explicit CKeyMetadata(int64_t nCreateTime_)

    {

        SetNull();

        nCreateTime = nCreateTime_;

    }

    SERIALIZE_METHODS(CKeyMetadata, obj)

    {

        READWRITE(obj.nVersion, obj.nCreateTime);

        if (obj.nVersion >= VERSION_WITH_HDDATA) {

  Branch (163:13): [True: 0, False: 0]

  Branch (163:13): [True: 0, False: 0]

            READWRITE(obj.hdKeypath, obj.hd_seed_id);

        }

        if (obj.nVersion >= VERSION_WITH_KEY_ORIGIN)

  Branch (166:13): [True: 0, False: 0]

  Branch (166:13): [True: 0, False: 0]

        {

            READWRITE(obj.key_origin);

            READWRITE(obj.has_key_origin);

        }

    }

Unexecuted instantiation: _ZN6wallet12CKeyMetadata16SerializationOpsI10DataStreamS0_17ActionUnserializeEEvRT0_RT_T1_

Unexecuted instantiation: _ZN6wallet12CKeyMetadata16SerializationOpsI10DataStreamKS0_15ActionSerializeEEvRT0_RT_T1_

    void SetNull()

    {

        nVersion = CKeyMetadata::CURRENT_VERSION;

        nCreateTime = 0;

        hdKeypath.clear();

        hd_seed_id.SetNull();

        key_origin.clear();

        has_key_origin = false;

    }

};

struct DbTxnListener

{

    std::function<void()> on_commit, on_abort;

};

/** Access to the wallet database.

 * Opens the database and provides read and write access to it. Each read and write is its own transaction.

 * Multiple operation transactions can be started using TxnBegin() and committed using TxnCommit()

 * Otherwise the transaction will be committed when the object goes out of scope.

 * Optionally (on by default) it will flush to disk on close.

 * Every 1000 writes will automatically trigger a flush to disk.

 */

class WalletBatch

{

private:

    template <typename K, typename T>

    bool WriteIC(const K& key, const T& value, bool fOverwrite = true)

    {

        if (!m_batch->Write(key, value, fOverwrite)) {

  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]
  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]

  Branch (202:13): [True: 0, False: 0]

            return false;

        }

        return true;

    }

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES8_ES8_EEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE22transaction_identifierILb0EEENS_9CWalletTxEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I22transaction_identifierILb0EES9_ILb1EEEE13ParamsWrapperI20TransactionSerParamsKSt10shared_ptrIK12CTransactionEEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyENS_12CKeyMetadataEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyES2_ISt6vectorIh16secure_allocatorIhEE7uint256EEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyES2_ISt6vectorIhSaIhEE7uint256EEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEjENS_10CMasterKeyEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CScriptENS_12CKeyMetadataEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CScriptEhEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE13CBlockLocatorEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEElEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEhE7uint256EEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I7uint2567CPubKeyEES2_ISt6vectorIh16secure_allocatorIhEES9_EEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I7uint2567CPubKeyEESt6vectorIhSaIhEEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256ENS_16WalletDescriptorEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairIS2_INSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256ES2_IjjEESt6vectorIhSaIhEEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairIS2_INSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256EjESt6vectorIhSaIhEEEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I22transaction_identifierILb0EEjEEhEEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_IS8_S8_EES8_EEbRKT_RKT0_b

Unexecuted instantiation: _ZN6wallet11WalletBatch7WriteICINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEmEEbRKT_RKT0_b

    template <typename K>

    bool EraseIC(const K& key)

    {

        if (!m_batch->Erase(key)) {

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

  Branch (211:13): [True: 0, False: 0]

            return false;

        }

        return true;

    }

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES8_EEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7uint256EEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE7CPubKeyEEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEjEEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEhEEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I7uint2567CPubKeyEEEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_I22transaction_identifierILb0EEjEEEEbRKT_

Unexecuted instantiation: _ZN6wallet11WalletBatch7EraseICISt4pairINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_IS8_S8_EEEEbRKT_

public:

    explicit WalletBatch(WalletDatabase &database) :

        m_batch(database.MakeBatch())

    {

    }

    WalletBatch(const WalletBatch&) = delete;

    WalletBatch& operator=(const WalletBatch&) = delete;

    bool WriteName(const std::string& strAddress, const std::string& strName);

    bool EraseName(const std::string& strAddress);

    bool WritePurpose(const std::string& strAddress, const std::string& purpose);

    bool ErasePurpose(const std::string& strAddress);

    // Write a CWalletTx and all variant witness txs (single tx record and multiple wtxvariant records)

    bool WriteFullTx(const CWalletTx& wtx);

    bool EraseTx(Txid hash);

    // Write a single witness variant of CWalletTx (single wtxvariant record)

    bool WriteWtxVariant(const Txid& txid, const CTransactionRef& tx);

    // Write only the canonical witness tx and all of the tx metadata (single tx record)

    bool WriteTxMetadata(const CWalletTx& wtx);

    bool WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, bool overwrite);

    bool WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata &keyMeta);

    bool WriteCryptedKey(const CPubKey& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, const CKeyMetadata &keyMeta);

    bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey);

    bool EraseMasterKey(unsigned int id);

    bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta);

    bool WriteBestBlock(const CBlockLocator& locator);

    bool ReadBestBlock(CBlockLocator& locator);

    // Returns true if wallet stores encryption keys

    bool IsEncrypted();

    bool WriteOrderPosNext(int64_t nOrderPosNext);

    bool WriteDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const CPrivKey& privkey);

    bool WriteCryptedDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const std::vector<unsigned char>& secret);

    bool WriteDescriptor(const uint256& desc_id, const WalletDescriptor& descriptor);

    bool WriteDescriptorDerivedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index, uint32_t der_index);

    bool WriteDescriptorParentCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);

    bool WriteDescriptorLastHardenedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);

    bool WriteDescriptorCacheItems(const uint256& desc_id, const DescriptorCache& cache);

    bool WriteLockedUTXO(const COutPoint& output);

    bool EraseLockedUTXO(const COutPoint& output);

    bool WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent);

    bool WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request);

    bool EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id);

    bool EraseAddressData(const CTxDestination& dest);

    bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256& id, bool internal);

    bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal);

    DBErrors LoadWallet(CWallet* pwallet);

    /**

     * Write the given `client_version` to m_batch, indicating the last version

     * of client software to load this wallet.

     *

     * @param[in]   client_version  `CLIENT_VERSION` outside of test code.

     * @return      A bool indicating whether or not the write succeeded.

     */

    bool WriteVersion(int client_version) { return m_batch->Write(DBKeys::VERSION, client_version); }

    //! Delete records of the given types

    bool EraseRecords(const std::unordered_set<std::string>& types);

    bool WriteWalletFlags(uint64_t flags);

    //! Begin a new transaction

    bool TxnBegin();

    //! Commit current transaction

    bool TxnCommit();

    //! Abort current transaction

    bool TxnAbort();

    bool HasActiveTxn() { return m_batch->HasActiveTxn(); }

    //! Registers db txn callback functions

    void RegisterTxnListener(const DbTxnListener& l);

private:

    std::unique_ptr<DatabaseBatch> m_batch;

    // External functions listening to the current db txn outcome.

    // Listeners are cleared at the end of the transaction.

    std::vector<DbTxnListener> m_txn_listeners;

};

/**

 * Executes the provided function 'func' within a database transaction context.

 *

 * This function ensures that all db modifications performed within 'func()' are

 * atomically committed to the db at the end of the process. And, in case of a

 * failure during execution, all performed changes are rolled back.

 *

 * @param database The db connection instance to perform the transaction on.

 * @param process_desc A description of the process being executed, used for logging purposes in the event of a failure.

 * @param func The function to be executed within the db txn context. It returns a boolean indicating whether to commit or roll back the txn.

 * @return true if the db txn executed successfully, false otherwise.

 */

bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func);

bool LoadKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);

bool LoadCryptedKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);

bool LoadEncryptionKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);

bool LoadHDChain(CWallet* pwallet, DataStream& ssValue, std::string& strErr);

//! Returns true if there are any DBKeys::LEGACY_TYPES record in the wallet db

bool HasLegacyRecords(CWallet& wallet);

bool HasLegacyRecords(CWallet& wallet, DatabaseBatch& batch);

} // namespace wallet

#endif // BITCOIN_WALLET_WALLETDB_H