diff --git a/src/txorphanage.h b/src/txorphanage.h index f7250b52e..88272ed8d 100644 --- a/src/txorphanage.h +++ b/src/txorphanage.h @@ -1,89 +1,95 @@ // Copyright (c) 2021 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 #include #include #include /** Guards orphan transactions and extra txs for compact blocks */ extern RecursiveMutex g_cs_orphans; -/** Data structure to keep track of orphan transactions */ +/** + * A class to track orphan transactions (failed on TX_MISSING_INPUTS) + * Since we cannot distinguish orphans from bad transactions with + * non-existent inputs, we heavily limit the number of orphans + * we keep and the duration we keep them for. + */ class TxOrphanage { public: /** Add a new orphan transaction */ bool AddTx(const CTransactionRef &tx, NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans); /** Check if we already have an orphan transaction */ bool HaveTx(const TxId &txid) const LOCKS_EXCLUDED(g_cs_orphans); /** - * Get the details of an orphan transaction (returns nullptr if not found) + * Get an orphan transaction and its originating peer + * (Transaction ref will be nullptr if not found) */ std::pair GetTx(const TxId &txid) const EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans); /** Erase an orphan by txid */ int EraseTx(const TxId &txid) EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans); /** * Erase all orphans announced by a peer (eg, after that peer disconnects) */ void EraseForPeer(NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans); - /** Erase all orphans included in / invalidated by a new block */ + /** Erase all orphans included in or invalidated by a new block */ void EraseForBlock(const CBlock &block) LOCKS_EXCLUDED(g_cs_orphans); /** Limit the orphanage to the given maximum */ unsigned int LimitOrphans(unsigned int max_orphans) EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans); /** * Add any orphans that list a particular tx as a parent into a peer's work * set (ie orphans that may have found their final missing parent, and so * should be reconsidered for the mempool) */ void AddChildrenToWorkSet(const CTransaction &tx, std::set &orphan_work_set) const EXCLUSIVE_LOCKS_REQUIRED(g_cs_orphans); protected: struct OrphanTx { CTransactionRef tx; NodeId fromPeer; int64_t nTimeExpire; size_t list_pos; }; /** * Map from txid to orphan transaction record. Limited by * -maxorphantx/DEFAULT_MAX_ORPHAN_TRANSACTIONS */ std::map m_orphans GUARDED_BY(g_cs_orphans); using OrphanMap = decltype(m_orphans); struct IteratorComparator { template bool operator()(const I &a, const I &b) const { return &(*a) < &(*b); } }; /** * Index from the parents' COutPoint into the m_orphans. Used * to remove orphan transactions from the m_orphans */ std::map> m_outpoint_to_orphan_it GUARDED_BY(g_cs_orphans); /** Orphan transactions in vector for quick random eviction */ std::vector m_orphan_list GUARDED_BY(g_cs_orphans); }; #endif // BITCOIN_TXORPHANAGE_H