LedgerData.hpp

#pragma once
 
#include "data/BackendInterface.hpp"
#include "rpc/JS.hpp"
#include "rpc/common/Checkers.hpp"
#include "rpc/common/MetaProcessors.hpp"
#include "rpc/common/Specs.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/common/Validators.hpp"
#include "util/log/Logger.hpp"
 
#include <boost/json/array.hpp>
#include <boost/json/conversion.hpp>
#include <boost/json/object.hpp>
#include <boost/json/value.hpp>
#include <xrpl/basics/base_uint.h>
#include <xrpl/protocol/ErrorCodes.h>
#include <xrpl/protocol/jss.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
 
namespace rpc {

class LedgerDataHandler {
    // dependencies
    std::shared_ptr<BackendInterface> sharedPtrBackend_;
    util::Logger log_{"RPC"};
 
public:
    // constants
    static constexpr uint32_t kLIMIT_BINARY = 2048;
    static constexpr uint32_t kLIMIT_JSON = 256;

    struct Output {
        uint32_t ledgerIndex{};
        std::string ledgerHash;
        std::optional<boost::json::object> header;
        boost::json::array states;
        std::optional<std::string> marker;
        std::optional<uint32_t> diffMarker;
        std::optional<bool> cacheFull;
        bool validated = true;
    };

    struct Input {
        std::optional<std::string> ledgerHash;
        std::optional<uint32_t> ledgerIndex;
        bool binary = false;
        uint32_t limit = LedgerDataHandler::kLIMIT_JSON;  // max 256 for json ; 2048 for binary
        std::optional<ripple::uint256> marker;
        std::optional<uint32_t> diffMarker;
        bool outOfOrder = false;
        ripple::LedgerEntryType type = ripple::LedgerEntryType::ltANY;
    };
 
    using Result = HandlerReturnType<Output>;

    LedgerDataHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
        : sharedPtrBackend_(std::move(sharedPtrBackend))
    {
    }

    static RpcSpecConstRef
    spec([[maybe_unused]] uint32_t apiVersion)
    {
        static auto const kRPC_SPEC = RpcSpec{
            {JS(binary), validation::Type<bool>{}},
            {"out_of_order", validation::Type<bool>{}},
            {JS(ledger_hash), validation::CustomValidators::uint256HexStringValidator},
            {JS(ledger_index), validation::CustomValidators::ledgerIndexValidator},
            {JS(limit), validation::Type<uint32_t>{}, validation::Min(1u)},
            {JS(marker),
             validation::Type<uint32_t, std::string>{},
             meta::IfType<std::string>{validation::CustomValidators::uint256HexStringValidator}},
            {JS(type), validation::CustomValidators::ledgerTypeValidator},
            {JS(ledger), check::Deprecated{}},
        };
        return kRPC_SPEC;
    }

    Result
    process(Input const& input, Context const& ctx) const;
 
private:
    friend void
    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);

    friend Input
    tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
};
}  // namespace rpc