thehub/hub/server/DoubleSpendProofStorage.cpp

/*
 * This file is part of the Flowee project
 * Copyright (c) 2019-2024 Tom Zander <tom@flowee.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include "DoubleSpendProofStorage.h"
#include <utils/utiltime.h>
#include <primitives/transaction.h>
#include "main.h"

static constexpr int64_t SECONDS_TO_KEEP_ORPHANS = 90;

DoubleSpendProofStorage::DoubleSpendProofStorage()
    : m_recentRejects(120000, 0.000001)
{
}

DoubleSpendProof DoubleSpendProofStorage::proof(int proof) const
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    auto iter = m_proofs.find(proof);
    if (iter != m_proofs.end())
        return iter->second;
    return DoubleSpendProof();
}

int DoubleSpendProofStorage::add(const DoubleSpendProof &proof)
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);

    uint256 hash = proof.createHash();
    auto lookupIter = m_dspIdLookupTable.find(hash);
    if (lookupIter != m_dspIdLookupTable.end())
        return -1;

    // in case of a REALLY long running server (or spam attack of DSProofs) we might
    // go past int-max. So check and then figure out the best value for m_nextId
    auto iter = m_proofs.find(m_nextId);
    while (iter != m_proofs.end()) {
        if (++m_nextId < 0)
            m_nextId = 1;
        iter = m_proofs.find(m_nextId);
    }
    m_proofs.insert(std::make_pair(m_nextId, proof));
    m_dspIdLookupTable.insert(std::make_pair(hash, m_nextId));

    return m_nextId++;
}

void DoubleSpendProofStorage::addOrphan(const DoubleSpendProof &proof, NodeId peerId)
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    const int id = add(proof);
    if (id == -1) // it was already in the storage
        return;

    m_orphans.insert(std::make_pair(id, std::make_pair(peerId, GetTime())));
    // we make it easy to find the orphan based on the (missing) parent transaction-Id
    m_prevTxIdLookupTable[proof.prevTxId().GetCheapHash()].push_back(id);
}

std::list<std::pair<int, int> > DoubleSpendProofStorage::findOrphans(const COutPoint &prevOut) const
{
    std::list<std::pair<int, int> > answer;
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    auto iter = m_prevTxIdLookupTable.find(prevOut.hash.GetCheapHash());
    if (iter == m_prevTxIdLookupTable.end())
        return answer;

    const std::deque<int> &q = iter->second;
    for (auto proofId = q.begin(); proofId != q.end(); ++proofId) {
        auto proofIter = m_proofs.find(*proofId);
        // we assume that m_prevTxIdLookupTable only refers to proofs still available in m_proofs
        assert (proofIter != m_proofs.end());
        if (proofIter->second.prevOutIndex() != int(prevOut.n))
            continue;
        // we only did lookup based on cheapHash (8 bytes instead of 32), check the full hash now.
        if (proofIter->second.prevTxId() == prevOut.hash) {
            auto orphanIter = m_orphans.find(*proofId);
            if (orphanIter != m_orphans.end()) {
                answer.push_back(std::make_pair(*proofId, orphanIter->second.first));
            }
        }
    }
    return answer;
}

void DoubleSpendProofStorage::claimOrphan(int proofId)
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    auto orphan = m_orphans.find(proofId);
    if (orphan != m_orphans.end()) {
        m_orphans.erase(orphan);

        // a proof that is essentially promoted will have its proofId known by the mempool and
        // thus we no longer need the find it via the lookup table. Lets delete its entry.
        for (auto iter = m_prevTxIdLookupTable.begin(); iter != m_prevTxIdLookupTable.end(); ++iter) {
            auto &list = iter->second;
            for (auto i = list.begin(); i != list.end(); ++i) {
                if (*i == proofId) {
                    list.erase(i);
                    if (list.size() == 0)
                        m_prevTxIdLookupTable.erase(iter);
                    return;
                }
            }
        }
    }
}

void DoubleSpendProofStorage::remove(int proof)
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    auto iter = m_proofs.find(proof);
    if (iter == m_proofs.end())
        return;

    // was it an orphan? Then it needs removal from m_orphans and its associated m_prevTxIdLookupTable
    auto orphan = m_orphans.find(iter->first);
    if (orphan != m_orphans.end()) {
        m_orphans.erase(orphan);
        auto orphanLookup = m_prevTxIdLookupTable.find(iter->second.prevTxId().GetCheapHash());
        if (orphanLookup != m_prevTxIdLookupTable.end()) {
            std::deque<int> &queue = orphanLookup->second;
            if (queue.size() == 1) {
                assert(queue.front() == proof);
                m_prevTxIdLookupTable.erase(orphanLookup);
            }
            else {
#ifndef NDEBUG
                size_t sizeBefore = queue.size();
#endif
                for (auto i = queue.begin(); i != queue.end(); ++i) {
                    if (*i == proof) {
                        queue.erase(i);
                        break;
                    }
                }
                assert(orphanLookup->second.size() < sizeBefore);
                assert(queue.size() > 0);
            }
        }
    }
    auto hash = iter->second.createHash();
    m_dspIdLookupTable.erase(hash);
    m_proofs.erase(iter);
}

DoubleSpendProof DoubleSpendProofStorage::lookup(const uint256 &proofId) const
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    auto lookupIter = m_dspIdLookupTable.find(proofId);
    if (lookupIter == m_dspIdLookupTable.end())
        return DoubleSpendProof();
    return m_proofs.at(lookupIter->second);
}

bool DoubleSpendProofStorage::exists(const uint256 &proofId) const
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    return m_dspIdLookupTable.find(proofId) != m_dspIdLookupTable.end();
}

void DoubleSpendProofStorage::periodicCleanup()
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    auto expire = GetTime() - SECONDS_TO_KEEP_ORPHANS;
    auto iter = m_orphans.begin();
    while (iter != m_orphans.end()) {
        if (iter->second.second <= expire) {
            const NodeId peerId = iter->second.first;
            const int proofId = iter->first;
            // first do the ++iter since the remove()
            // method will erase the item from the orphans list and
            // that would invalidate our iterator.
            ++iter;
            remove(proofId);

            if (peerId != -1) { // not whitelisted
                logInfo(Log::DSProof) << "punish" << peerId;
                LOCK(cs_main);
                Misbehaving(peerId, 1); // they sent us a dsproof while never sending the owning transaction.
            }
        }
        else {
            ++iter;
        }
    }
    logDebug(Log::DSProof) << "DSP orphan count:" << m_orphans.size() << "DSProof count" << m_proofs.size();
}

bool DoubleSpendProofStorage::isRecentlyRejectedProof(const uint256 &proofHash) const
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    return m_recentRejects.contains(proofHash);
}

void DoubleSpendProofStorage::markProofRejected(const uint256 &proofHash)
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    m_recentRejects.insert(proofHash);
}

void DoubleSpendProofStorage::newBlockFound()
{
    std::lock_guard<std::recursive_mutex> lock(m_lock);
    m_recentRejects.clear();
}