txorphanage.h

Go to the documentation of this file.

// 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_TXORPHANAGE_H
#define BITCOIN_TXORPHANAGE_H

#include <consensus/validation.h>
#include <net.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
#include <sync.h>
#include <util/time.h>

#include <map>
#include <set>

static constexpr auto ORPHAN_TX_EXPIRE_TIME{20min};
static constexpr auto ORPHAN_TX_EXPIRE_INTERVAL{5min};

class TxOrphanage {
public:
    bool AddTx(const CTransactionRef& tx, NodeId peer);

    bool AddAnnouncer(const Wtxid& wtxid, NodeId peer);

    CTransactionRef GetTx(const Wtxid& wtxid) const;

    bool HaveTx(const Wtxid& wtxid) const;

    bool HaveTxFromPeer(const Wtxid& wtxid, NodeId peer) const;

    CTransactionRef GetTxToReconsider(NodeId peer);

    int EraseTx(const Wtxid& wtxid);

    void EraseForPeer(NodeId peer);

    void EraseForBlock(const CBlock& block);

    void LimitOrphans(unsigned int max_orphans, FastRandomContext& rng);

    void AddChildrenToWorkSet(const CTransaction& tx, FastRandomContext& rng);

    bool HaveTxToReconsider(NodeId peer);

    std::vector<CTransactionRef> GetChildrenFromSamePeer(const CTransactionRef& parent, NodeId nodeid) const;

    size_t Size() const
    {
        return m_orphans.size();
    }

    struct OrphanTxBase {
        CTransactionRef tx;
        std::set<NodeId> announcers;
        NodeSeconds nTimeExpire;

        unsigned int GetUsage() const {
            return GetTransactionWeight(*tx);
        }
    };

    std::vector<OrphanTxBase> GetOrphanTransactions() const;

    unsigned int TotalOrphanUsage() const { return m_total_orphan_usage; }

    unsigned int UsageByPeer(NodeId peer) const {
        auto peer_it = m_peer_orphanage_info.find(peer);
        return peer_it == m_peer_orphanage_info.end() ? 0 : peer_it->second.m_total_usage;
    }

    void SanityCheck() const;

protected:
    struct OrphanTx : public OrphanTxBase {
        size_t list_pos;
    };

    unsigned int m_total_orphan_usage{0};

    unsigned int m_total_announcements{0};

    std::map<Wtxid, OrphanTx> m_orphans;

    struct PeerOrphanInfo {
        std::set<Wtxid> m_work_set;

        unsigned int m_total_usage{0};
    };
    std::map<NodeId, PeerOrphanInfo> m_peer_orphanage_info;

    using OrphanMap = decltype(m_orphans);

    struct IteratorComparator
    {
        template<typename I>
        bool operator()(const I& a, const I& b) const
        {
            return a->first < b->first;
        }
    };

    std::map<COutPoint, std::set<OrphanMap::iterator, IteratorComparator>> m_outpoint_to_orphan_it;

    std::vector<OrphanMap::iterator> m_orphan_list;

    NodeSeconds m_next_sweep{0s};
};

#endif // BITCOIN_TXORPHANAGE_H