Source.hpp

#pragma once
 
#include "etl/InitialLoadObserverInterface.hpp"
#include "etl/LoadBalancerInterface.hpp"
#include "etl/NetworkValidatedLedgersInterface.hpp"
#include "feed/SubscriptionManagerInterface.hpp"
#include "rpc/Errors.hpp"
#include "util/config/ObjectView.hpp"
 
#include <boost/asio/io_context.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/json/object.hpp>
#include <boost/uuid/uuid.hpp>
#include <grpcpp/support/status.h>
#include <org/xrpl/rpc/v1/get_ledger.pb.h>
 
#include <chrono>
#include <cstdint>
#include <expected>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
namespace etl {

class SourceBase {
public:
    using OnConnectHook = std::function<void()>;
    using OnDisconnectHook = std::function<void(bool)>;
    using OnLedgerClosedHook = std::function<void()>;
 
    virtual ~SourceBase() = default;

    virtual void
    run() = 0;

    virtual void
    stop(boost::asio::yield_context yield) = 0;

    [[nodiscard]] virtual bool
    isConnected() const = 0;

    virtual void
    setForwarding(bool isForwarding) = 0;

    [[nodiscard]] virtual boost::json::object
    toJson() const = 0;

    [[nodiscard]] virtual std::string
    toString() const = 0;

    [[nodiscard]] virtual bool
    hasLedger(uint32_t sequence) const = 0;

    [[nodiscard]] virtual std::pair<grpc::Status, org::xrpl::rpc::v1::GetLedgerResponse>
    fetchLedger(uint32_t sequence, bool getObjects = true, bool getObjectNeighbors = false) = 0;

    virtual InitialLedgerLoadResult
    loadInitialLedger(
        uint32_t sequence,
        std::uint32_t numMarkers,
        InitialLoadObserverInterface& loader
    ) = 0;

    [[nodiscard]] virtual std::expected<boost::json::object, rpc::ClioError>
    forwardToRippled(
        boost::json::object const& request,
        std::optional<std::string> const& forwardToRippledClientIp,
        std::string_view xUserValue,
        boost::asio::yield_context yield
    ) const = 0;
};
 
using SourcePtr = std::unique_ptr<SourceBase>;
 
using SourceFactory = std::function<SourcePtr(
    util::config::ObjectView const& config,
    boost::asio::io_context& ioc,
    std::shared_ptr<feed::SubscriptionManagerInterface> subscriptions,
    std::shared_ptr<NetworkValidatedLedgersInterface> validatedLedgers,
    std::chrono::steady_clock::duration forwardingTimeout,
    SourceBase::OnConnectHook onConnect,
    SourceBase::OnDisconnectHook onDisconnect,
    SourceBase::OnLedgerClosedHook onLedgerClosed
)>;

[[nodiscard]] SourcePtr
makeSource(
    util::config::ObjectView const& config,
    boost::asio::io_context& ioc,
    std::shared_ptr<feed::SubscriptionManagerInterface> subscriptions,
    std::shared_ptr<NetworkValidatedLedgersInterface> validatedLedgers,
    std::chrono::steady_clock::duration forwardingTimeout,
    SourceBase::OnConnectHook onConnect,
    SourceBase::OnDisconnectHook onDisconnect,
    SourceBase::OnLedgerClosedHook onLedgerClosed
);
 
}  // namespace etl