TransactionFeed.hpp

#pragma once
 
#include "data/AmendmentCenterInterface.hpp"
#include "data/BackendInterface.hpp"
#include "data/Types.hpp"
#include "feed/Types.hpp"
#include "feed/impl/TrackableSignal.hpp"
#include "feed/impl/TrackableSignalMap.hpp"
#include "feed/impl/Util.hpp"
#include "util/async/AnyExecutionContext.hpp"
#include "util/async/AnyStrand.hpp"
#include "util/log/Logger.hpp"
#include "util/prometheus/Gauge.hpp"
 
#include <boost/asio/io_context.hpp>
#include <boost/asio/strand.hpp>
#include <fmt/format.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Book.h>
#include <xrpl/protocol/LedgerHeader.h>
#include <xrpl/protocol/MPTIssue.h>  // IWYU pragma: keep (std::hash<xrpl::MPTID>)
#include <xrpl/protocol/UintTypes.h>
 
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <unordered_set>
 
namespace feed::impl {
 
class TransactionFeed {
    // Hold two versions of transaction messages
    struct AllVersionsMsgsType {
        std::string v1;
        std::string v2;
    };
 
    struct TransactionSlot {
        std::reference_wrapper<TransactionFeed> feed;
        std::weak_ptr<Subscriber> subscriptionContextWeakPtr;
 
        TransactionSlot(TransactionFeed& feed, SubscriberSharedPtr const& connection)
            : feed(feed), subscriptionContextWeakPtr(connection)
        {
        }
 
        void
        operator()(std::shared_ptr<AllVersionsMsgsType> const& allVersionMsgs) const;
    };
 
    util::Logger logger_{"Subscriptions"};
 
    util::async::AnyStrand strand_;
    std::reference_wrapper<util::prometheus::GaugeInt> subAllCount_;
    std::reference_wrapper<util::prometheus::GaugeInt> subAccountCount_;
    std::reference_wrapper<util::prometheus::GaugeInt> subBookCount_;
    std::reference_wrapper<util::prometheus::GaugeInt> subMPTIssuanceCount_;
 
    TrackableSignalMap<xrpl::AccountID, Subscriber, std::shared_ptr<AllVersionsMsgsType> const&>
        accountSignal_;
    TrackableSignalMap<xrpl::Book, Subscriber, std::shared_ptr<AllVersionsMsgsType> const&>
        bookSignal_;
    TrackableSignalMap<xrpl::MPTID, Subscriber, std::shared_ptr<AllVersionsMsgsType> const&>
        mptIssuanceSignal_;
    TrackableSignal<Subscriber, std::shared_ptr<AllVersionsMsgsType> const&> signal_;
 
    // Signals for proposed tx subscribers
    TrackableSignalMap<xrpl::AccountID, Subscriber, std::shared_ptr<AllVersionsMsgsType> const&>
        accountProposedSignal_;
    TrackableSignal<Subscriber, std::shared_ptr<AllVersionsMsgsType> const&> txProposedSignal_;
 
    std::unordered_set<SubscriberPtr> notified_;  // Used by slots to prevent double notifications
                                                  // if tx contains multiple subscribed accounts
 
public:
    TransactionFeed(util::async::AnyExecutionContext& executionCtx)
        : strand_(executionCtx.makeStrand())
        , subAllCount_(getSubscriptionsGaugeInt("tx"))
        , subAccountCount_(getSubscriptionsGaugeInt("account"))
        , subBookCount_(getSubscriptionsGaugeInt("book"))
        , subMPTIssuanceCount_(getSubscriptionsGaugeInt("mpt_issuance"))
    {
    }

    TransactionFeed(TransactionFeed&&) = delete;

    void
    sub(SubscriberSharedPtr const& subscriber);

    void
    sub(xrpl::AccountID const& account, SubscriberSharedPtr const& subscriber);

    void
    sub(xrpl::Book const& book, SubscriberSharedPtr const& subscriber);

    void
    sub(xrpl::MPTID const& mptIssuanceID, SubscriberSharedPtr const& subscriber);

    void
    subProposed(SubscriberSharedPtr const& subscriber);

    void
    subProposed(xrpl::AccountID const& account, SubscriberSharedPtr const& subscriber);

    void
    unsub(SubscriberSharedPtr const& subscriber);

    void
    unsub(xrpl::AccountID const& account, SubscriberSharedPtr const& subscriber);

    void
    unsubProposed(SubscriberSharedPtr const& subscriber);

    void
    unsubProposed(xrpl::AccountID const& account, SubscriberSharedPtr const& subscriber);

    void
    unsub(xrpl::Book const& book, SubscriberSharedPtr const& subscriber);

    void
    unsub(xrpl::MPTID const& mptIssuanceID, SubscriberSharedPtr const& subscriber);

    void
    pub(data::TransactionAndMetadata const& txMeta,
        xrpl::LedgerHeader const& lgrInfo,
        std::shared_ptr<data::BackendInterface const> const& backend,
        std::shared_ptr<data::AmendmentCenterInterface const> const& amendmentCenter,
        uint32_t networkID);

    std::uint64_t
    transactionSubCount() const;

    std::uint64_t
    accountSubCount() const;

    std::uint64_t
    bookSubCount() const;

    std::uint64_t
    mptIssuanceSubCount() const;
 
private:
    void
    unsubInternal(SubscriberPtr subscriber);
 
    void
    unsubInternal(xrpl::AccountID const& account, SubscriberPtr subscriber);
 
    void
    unsubProposedInternal(SubscriberPtr subscriber);
 
    void
    unsubProposedInternal(xrpl::AccountID const& account, SubscriberPtr subscriber);
 
    void
    unsubInternal(xrpl::Book const& book, SubscriberPtr subscriber);
 
    void
    unsubInternal(xrpl::MPTID const& mptIssuanceID, SubscriberPtr subscriber);
};
}  // namespace feed::impl