txorphanage.h

Go to the documentation of this file.

// Copyright (c) 2021-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_NODE_TXORPHANAGE_H
#define BITCOIN_NODE_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>
 
namespace node {
inline constexpr int64_t DEFAULT_RESERVED_ORPHAN_WEIGHT_PER_PEER{404'000};
inline constexpr unsigned int DEFAULT_MAX_ORPHANAGE_LATENCY_SCORE{3'000};
 
// Keep the connection caps below the default global latency limit to avoid a zero per-peer share.
static_assert(MAX_PEER_CONNECTIONS + MAX_ADDNODE_CONNECTIONS + MAX_PRIVATE_BROADCAST_CONNECTIONS < DEFAULT_MAX_ORPHANAGE_LATENCY_SCORE);

class TxOrphanage {
public:
    using Usage = int64_t;
    using Count = unsigned int;

    struct OrphanInfo {
        CTransactionRef tx;
        std::set<NodeId> announcers;
 
        // Constructor with moved announcers
        OrphanInfo(CTransactionRef tx, std::set<NodeId>&& announcers) :
            tx(std::move(tx)),
            announcers(std::move(announcers))
        {}
    };
 
    virtual ~TxOrphanage() = default;

    virtual bool AddTx(const CTransactionRef& tx, NodeId peer) = 0;

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

    virtual CTransactionRef GetTx(const Wtxid& wtxid) const = 0;

    virtual bool HaveTx(const Wtxid& wtxid) const = 0;

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

    virtual CTransactionRef GetTxToReconsider(NodeId peer) = 0;

    virtual bool EraseTx(const Wtxid& wtxid) = 0;

    virtual void EraseForPeer(NodeId peer) = 0;

    virtual void EraseForBlock(const CBlock& block) = 0;

    virtual std::vector<std::pair<Wtxid, NodeId>> AddChildrenToWorkSet(const CTransaction& tx, FastRandomContext& rng) = 0;

    virtual bool HaveTxToReconsider(NodeId peer) = 0;

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

    virtual std::vector<OrphanInfo> GetOrphanTransactions() const = 0;

    virtual Usage TotalOrphanUsage() const = 0;

    virtual Usage UsageByPeer(NodeId peer) const = 0;

    virtual void SanityCheck() const = 0;

    virtual Count CountAnnouncements() const = 0;

    virtual Count CountUniqueOrphans() const = 0;

    virtual Count AnnouncementsFromPeer(NodeId peer) const = 0;

    virtual Count LatencyScoreFromPeer(NodeId peer) const = 0;

    virtual Count MaxGlobalLatencyScore() const = 0;

    virtual Count TotalLatencyScore() const = 0;

    virtual Usage ReservedPeerUsage() const = 0;

    virtual Count MaxPeerLatencyScore() const = 0;

    virtual Usage MaxGlobalUsage() const = 0;
};

std::unique_ptr<TxOrphanage> MakeTxOrphanage() noexcept;
std::unique_ptr<TxOrphanage> MakeTxOrphanage(TxOrphanage::Count max_global_latency_score, TxOrphanage::Usage reserved_peer_usage) noexcept;
} // namespace node
#endif // BITCOIN_NODE_TXORPHANAGE_H