txpool.h

Go to the documentation of this file.

// 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_TXPOOL_H
#define BITCOIN_TXPOOL_H
 
#include <nodeid.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
 
#include <sync.h>
#include <util/time.h>
 
#include <chrono>
#include <map>
#include <set>
#include <vector>
 
class FastRandomContext;
 
class TxPool {
public:
    TxPool(const std::string &txKindIn, std::chrono::seconds expireTimeIn,
           std::chrono::seconds expireIntervalIn)
        : txKind(txKindIn), expireTime(expireTimeIn),
          expireInterval(expireIntervalIn) {}
 
    bool AddTx(const CTransactionRef &tx, NodeId peer)
        EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    bool HaveTx(const TxId &txid) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    CTransactionRef GetTxToReconsider(NodeId peer)
        EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    int EraseTx(const TxId &txid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    void EraseForPeer(NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    void EraseForBlock(const CBlock &block) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    unsigned int LimitTxs(unsigned int max_txs, FastRandomContext &rng)
        EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    void AddChildrenToWorkSet(const CTransaction &tx)
        EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    bool HaveTxToReconsider(NodeId peer) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    std::vector<CTransactionRef>
    GetChildrenFromSamePeer(const CTransactionRef &parent, NodeId nodeid) const
        EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    std::vector<std::pair<CTransactionRef, NodeId>>
    GetChildrenFromDifferentPeer(const CTransactionRef &parent,
                                 NodeId nodeid) const
        EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
 
    size_t Size() const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex) {
        LOCK(m_mutex);
        return m_pool_txs.size();
    }
 
protected:
    const std::string txKind;
    const std::chrono::seconds expireTime;
    const std::chrono::seconds expireInterval;
 
    mutable Mutex m_mutex;
 
    struct PoolTx {
        CTransactionRef tx;
        NodeId fromPeer;
        NodeSeconds nTimeExpire;
        size_t list_pos;
    };
 
    std::map<TxId, PoolTx> m_pool_txs GUARDED_BY(m_mutex);
 
    std::map<NodeId, std::set<TxId>> m_peer_work_set GUARDED_BY(m_mutex);
 
    using PoolTxMap = decltype(m_pool_txs);
 
    struct IteratorComparator {
        template <typename I> bool operator()(const I &a, const I &b) const {
            return a->first < b->first;
        }
    };
 
    std::map<COutPoint, std::set<PoolTxMap ::iterator, IteratorComparator>>
        m_outpoint_to_tx_it GUARDED_BY(m_mutex);
 
    std::vector<PoolTxMap::iterator> m_txs_list GUARDED_BY(m_mutex);
 
    int EraseTxNoLock(const TxId &txid) EXCLUSIVE_LOCKS_REQUIRED(m_mutex);
 
    NodeSeconds m_next_sweep GUARDED_BY(m_mutex){0s};
};
 
#endif // BITCOIN_TXPOOL_H