dash/src/spentindex.h

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2015 The Bitcoin Core developers
// Copyright (c) 2023 The Dash Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_SPENTINDEX_H
#define BITCOIN_SPENTINDEX_H

#include <addressindex.h>
#include <amount.h>
#include <script/script.h>
#include <serialize.h>
#include <uint256.h>

#include <tuple>

struct CSpentIndexKey {
public:
    uint256 m_tx_hash;
    uint32_t m_tx_index{0};

public:
    CSpentIndexKey() {
        SetNull();
    }

    CSpentIndexKey(uint256 txout_hash, uint32_t txout_index) :
        m_tx_hash{txout_hash}, m_tx_index{txout_index} {};

    void SetNull() {
        m_tx_hash.SetNull();
        m_tx_index = 0;
    }

public:
    SERIALIZE_METHODS(CSpentIndexKey, obj)
    {
        READWRITE(obj.m_tx_hash, obj.m_tx_index);
    }
};

struct CSpentIndexValue {
public:
    uint256 m_tx_hash;
    uint32_t m_tx_index{0};
    int32_t m_block_height{0};
    CAmount m_amount{0};
    int32_t m_address_type{AddressType::UNKNOWN};
    uint160 m_address_bytes;

public:
    CSpentIndexValue() {
        SetNull();
    }

    CSpentIndexValue(uint256 txin_hash, uint32_t txin_index, int32_t block_height, CAmount amount, int32_t address_type,
                     uint160 address_bytes) :
        m_tx_hash{txin_hash},
        m_tx_index{txin_index},
        m_block_height{block_height},
        m_amount{amount},
        m_address_type{address_type},
        m_address_bytes{address_bytes} {};

    void SetNull() {
        m_tx_hash.SetNull();
        m_tx_index = 0;
        m_block_height = 0;
        m_amount = 0;
        m_address_type = AddressType::UNKNOWN;
        m_address_bytes.SetNull();
    }

    bool IsNull() const {
        return m_tx_hash.IsNull();
    }

public:
    SERIALIZE_METHODS(CSpentIndexValue, obj)
    {
        READWRITE(obj.m_tx_hash, obj.m_tx_index, obj.m_block_height, obj.m_amount, obj.m_address_type, obj.m_address_bytes);
    }
};

struct CSpentIndexKeyCompare
{
    bool operator()(const CSpentIndexKey& a, const CSpentIndexKey& b) const {
        auto to_tuple = [](const CSpentIndexKey& obj) {
            return std::tie(obj.m_tx_hash, obj.m_tx_index);
        };
        return to_tuple(a) < to_tuple(b);
    }
};

struct CSpentIndexTxInfo
{
    std::map<CSpentIndexKey, CSpentIndexValue, CSpentIndexKeyCompare> mSpentInfo;
};

struct CTimestampIndexIteratorKey {
public:
    uint32_t m_time;

public:
    CTimestampIndexIteratorKey() {
        SetNull();
    }

    CTimestampIndexIteratorKey(uint32_t time) : m_time{time} {};

    void SetNull() {
        m_time = 0;
    }

public:
    size_t GetSerializeSize(int nType, int nVersion) const {
        return 4;
    }

    template<typename Stream>
    void Serialize(Stream& s) const {
        ser_writedata32be(s, m_time);
    }

    template<typename Stream>
    void Unserialize(Stream& s) {
        m_time = ser_readdata32be(s);
    }
};

struct CTimestampIndexKey {
public:
    uint32_t m_block_time;
    uint256 m_block_hash;

public:
    CTimestampIndexKey() {
        SetNull();
    }

    CTimestampIndexKey(uint32_t block_time, uint256 block_hash) :
        m_block_time{block_time}, m_block_hash{block_hash} {};

    void SetNull() {
        m_block_time = 0;
        m_block_hash.SetNull();
    }

public:
    size_t GetSerializeSize(int nType, int nVersion) const {
        return 36;
    }

    template<typename Stream>
    void Serialize(Stream& s) const {
        ser_writedata32be(s, m_block_time);
        m_block_hash.Serialize(s);
    }

    template<typename Stream>
    void Unserialize(Stream& s) {
        m_block_time = ser_readdata32be(s);
        m_block_hash.Unserialize(s);
    }
};

struct CAddressUnspentKey {
public:
    uint32_t m_address_type{AddressType::UNKNOWN};
    uint160 m_address_bytes;
    uint256 m_tx_hash;
    size_t m_tx_index{0};

public:
    CAddressUnspentKey() {
        SetNull();
    }

    CAddressUnspentKey(uint32_t address_type, uint160 address_bytes, uint256 tx_hash, size_t tx_index) :
        m_address_type{address_type}, m_address_bytes{address_bytes}, m_tx_hash{tx_hash}, m_tx_index{tx_index} {};

    void SetNull() {
        m_address_type = AddressType::UNKNOWN;
        m_address_bytes.SetNull();
        m_tx_hash.SetNull();
        m_tx_index = 0;
    }

public:
    size_t GetSerializeSize(int nType, int nVersion) const {
        return 57;
    }

    template<typename Stream>
    void Serialize(Stream& s) const {
        ser_writedata8(s, m_address_type);
        m_address_bytes.Serialize(s);
        m_tx_hash.Serialize(s);
        ser_writedata32(s, m_tx_index);
    }

    template<typename Stream>
    void Unserialize(Stream& s) {
        m_address_type = ser_readdata8(s);
        m_address_bytes.Unserialize(s);
        m_tx_hash.Unserialize(s);
        m_tx_index = ser_readdata32(s);
    }
};

struct CAddressUnspentValue {
public:
    CAmount m_amount{-1};
    CScript m_tx_script;
    int32_t m_block_height;

public:
    CAddressUnspentValue() {
        SetNull();
    }

    CAddressUnspentValue(CAmount amount, CScript tx_script, int32_t block_height) :
        m_amount{amount}, m_tx_script{tx_script}, m_block_height{block_height} {};

    void SetNull() {
        m_amount = -1;
        m_tx_script.clear();
        m_block_height = 0;
    }

    bool IsNull() const {
        return (m_amount == -1);
    }

public:
    SERIALIZE_METHODS(CAddressUnspentValue, obj)
    {
        READWRITE(obj.m_amount, obj.m_tx_script, obj.m_block_height);
    }
};

struct CAddressIndexKey {
public:
    uint32_t m_address_type{AddressType::UNKNOWN};
    uint160 m_address_bytes;
    int32_t m_block_height{0};
    uint32_t m_block_tx_pos{0};
    uint256 m_tx_hash;
    size_t m_tx_index{0};
    bool m_tx_spent{false};

public:
    CAddressIndexKey() {
        SetNull();
    }

    CAddressIndexKey(uint32_t address_type, uint160 address_bytes, int32_t block_height, uint32_t block_tx_pos, uint256 tx_hash,
                     size_t tx_index, bool tx_spent) :
        m_address_type{address_type},
        m_address_bytes{address_bytes},
        m_block_height{block_height},
        m_block_tx_pos{block_tx_pos},
        m_tx_hash{tx_hash},
        m_tx_index{tx_index},
        m_tx_spent{tx_spent} {};

    void SetNull() {
        m_address_type = AddressType::UNKNOWN;
        m_address_bytes.SetNull();
        m_block_height = 0;
        m_block_tx_pos = 0;
        m_tx_hash.SetNull();
        m_tx_index = 0;
        m_tx_spent = false;
    }

public:
    size_t GetSerializeSize(int nType, int nVersion) const {
        return 66;
    }

    template<typename Stream>
    void Serialize(Stream& s) const {
        ser_writedata8(s, m_address_type);
        m_address_bytes.Serialize(s);
        // Heights are stored big-endian for key sorting in LevelDB
        ser_writedata32be(s, m_block_height);
        ser_writedata32be(s, m_block_tx_pos);
        m_tx_hash.Serialize(s);
        ser_writedata32(s, m_tx_index);
        char f = m_tx_spent;
        ser_writedata8(s, f);
    }

    template<typename Stream>
    void Unserialize(Stream& s) {
        m_address_type = ser_readdata8(s);
        m_address_bytes.Unserialize(s);
        m_block_height = ser_readdata32be(s);
        m_block_tx_pos = ser_readdata32be(s);
        m_tx_hash.Unserialize(s);
        m_tx_index = ser_readdata32(s);
        char f = ser_readdata8(s);
        m_tx_spent = f;
    }
};

struct CAddressIndexIteratorKey {
public:
    uint32_t m_address_type{AddressType::UNKNOWN};
    uint160 m_address_bytes;

public:
    CAddressIndexIteratorKey() {
        SetNull();
    }

    CAddressIndexIteratorKey(uint32_t address_type, uint160 address_bytes) :
        m_address_type{address_type}, m_address_bytes{address_bytes} {};

    void SetNull() {
        m_address_type = AddressType::UNKNOWN;
        m_address_bytes.SetNull();
    }

public:
    size_t GetSerializeSize(int nType, int nVersion) const {
        return 21;
    }

    template<typename Stream>
    void Serialize(Stream& s) const {
        ser_writedata8(s, m_address_type);
        m_address_bytes.Serialize(s);
    }

    template<typename Stream>
    void Unserialize(Stream& s) {
        m_address_type = ser_readdata8(s);
        m_address_bytes.Unserialize(s);
    }
};

struct CAddressIndexIteratorHeightKey {
public:
    uint32_t m_address_type{AddressType::UNKNOWN};
    uint160 m_address_bytes;
    int32_t m_block_height{0};

public:
    CAddressIndexIteratorHeightKey() {
        SetNull();
    }

    CAddressIndexIteratorHeightKey(uint32_t address_type, uint160 address_bytes, int32_t block_height) :
        m_address_type{address_type}, m_address_bytes{address_bytes}, m_block_height{block_height} {};

    void SetNull() {
        m_address_type = AddressType::UNKNOWN;
        m_address_bytes.SetNull();
        m_block_height = 0;
    }

public:
    size_t GetSerializeSize(int nType, int nVersion) const {
        return 25;
    }

    template<typename Stream>
    void Serialize(Stream& s) const {
        ser_writedata8(s, m_address_type);
        m_address_bytes.Serialize(s);
        ser_writedata32be(s, m_block_height);
    }

    template<typename Stream>
    void Unserialize(Stream& s) {
        m_address_type = ser_readdata8(s);
        m_address_bytes.Unserialize(s);
        m_block_height = ser_readdata32be(s);
    }
};

#endif // BITCOIN_SPENTINDEX_H