SubscriptionManagerInterface.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2024, the clio developers.
 
    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#pragma once
 
#include "data/Types.hpp"
#include "feed/Types.hpp"
 
#include <boost/asio/executor_work_guard.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/json/object.hpp>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Book.h>
#include <xrpl/protocol/Fees.h>
#include <xrpl/protocol/LedgerHeader.h>
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace feed {

class SubscriptionManagerInterface {
public:
    virtual ~SubscriptionManagerInterface() = default;

    virtual void
    stop() = 0;

    virtual void
    subBookChanges(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubBookChanges(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    pubBookChanges(
        ripple::LedgerHeader const& lgrInfo,
        std::vector<data::TransactionAndMetadata> const& transactions
    ) = 0;

    virtual void
    subProposedTransactions(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubProposedTransactions(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    subProposedAccount(ripple::AccountID const& account, SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubProposedAccount(
        ripple::AccountID const& account,
        SubscriberSharedPtr const& subscriber
    ) = 0;

    virtual void
    forwardProposedTransaction(boost::json::object const& receivedTxJson) = 0;

    virtual boost::json::object
    subLedger(boost::asio::yield_context yield, SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubLedger(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    pubLedger(
        ripple::LedgerHeader const& lgrInfo,
        ripple::Fees const& fees,
        std::string const& ledgerRange,
        std::uint32_t txnCount
    ) = 0;

    virtual void
    subManifest(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubManifest(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    forwardManifest(boost::json::object const& manifestJson) = 0;

    virtual void
    subValidation(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubValidation(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    forwardValidation(boost::json::object const& validationJson) = 0;

    virtual void
    subTransactions(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubTransactions(SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    subAccount(ripple::AccountID const& account, SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubAccount(ripple::AccountID const& account, SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    subBook(ripple::Book const& book, SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    unsubBook(ripple::Book const& book, SubscriberSharedPtr const& subscriber) = 0;

    virtual void
    pubTransaction(
        data::TransactionAndMetadata const& txMeta,
        ripple::LedgerHeader const& lgrInfo
    ) = 0;

    virtual boost::json::object
    report() const = 0;

    virtual void
    setNetworkID(uint32_t networkID) = 0;

    virtual uint32_t
    getNetworkID() const = 0;
};
 
}  // namespace feed