clio/handlers/LedgerData.cpp

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012-2014 Ripple Labs Inc.

    Permission to use, copy, modify, and/or 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.
*/
//==============================================================================

#include <ripple/app/ledger/LedgerToJson.h>
#include <ripple/protocol/STLedgerEntry.h>
#include <boost/json.hpp>
#include <handlers/RPCHelpers.h>
#include <reporting/BackendInterface.h>
// Get state nodes from a ledger
//   Inputs:
//     limit:        integer, maximum number of entries
//     marker:       opaque, resume point
//     binary:       boolean, format
//     type:         string // optional, defaults to all ledger node types
//   Outputs:
//     ledger_hash:  chosen ledger's hash
//     ledger_index: chosen ledger's index
//     state:        array of state nodes
//     marker:       resume point, if any
//
//
boost::json::object
doLedgerData(
    boost::json::object const& request,
    BackendInterface const& backend)
{
    boost::json::object response;
    auto ledgerSequence = ledgerSequenceFromRequest(request, backend);
    if (!ledgerSequence)
    {
        response["error"] = "Empty database";
        return response;
    }
    auto ledger = backend.fetchLedgerBySequence(*ledgerSequence);
    if (!ledger)
    {
        response["error"] = "Ledger not found";
        return response;
    }

    std::optional<ripple::uint256> cursor;
    if (request.contains("cursor"))
    {
        BOOST_LOG_TRIVIAL(debug) << __func__ << " : parsing cursor";
        cursor = ripple::uint256{};
        if (!cursor->parseHex(request.at("cursor").as_string().c_str()))
        {
            response["error"] = "Invalid cursor";
            response["request"] = request;
            return response;
        }
    }
    bool binary =
        request.contains("binary") ? request.at("binary").as_bool() : false;
    size_t limit = request.contains("limit") ? request.at("limit").as_int64()
                                             : (binary ? 2048 : 256);
    Backend::LedgerPage page;
    auto start = std::chrono::system_clock::now();
    page = backend.fetchLedgerPage(cursor, *ledgerSequence, limit);

    auto end = std::chrono::system_clock::now();

    auto time =
        std::chrono::duration_cast<std::chrono::microseconds>(end - start)
            .count();
    boost::json::array objects;
    std::vector<Backend::LedgerObject>& results = page.objects;
    std::optional<ripple::uint256> const& returnedCursor = page.cursor;
    BOOST_LOG_TRIVIAL(debug)
        << __func__ << " number of results = " << results.size();
    for (auto const& [key, object] : results)
    {
        ripple::STLedgerEntry sle{
            ripple::SerialIter{object.data(), object.size()}, key};
        if (binary)
        {
            boost::json::object entry;
            entry["data"] = ripple::serializeHex(sle);
            entry["index"] = ripple::to_string(sle.key());
            objects.push_back(entry);
        }
        else
            objects.push_back(toJson(sle));
    }
    response["objects"] = objects;
    if (returnedCursor)
        response["cursor"] = ripple::strHex(*returnedCursor);

    response["num_results"] = results.size();
    response["db_time"] = time;
    response["time_per_result"] = time / (results.size() ? results.size() : 1);
    if (page.warning)
    {
        response["warning"] =
            "Periodic database update in progress. Data for this ledger may be "
            "incomplete. Data should be complete "
            "within a few minutes. Other RPC calls are not affected, "
            "regardless of ledger. This "
            "warning is only present on the first "
            "page of the ledger";
    }
    return response;
}

/*
std::pair<org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status>
doLedgerDataGrpc(
    RPC::GRPCContext<org::xrpl::rpc::v1::GetLedgerDataRequest>& context)
{
    org::xrpl::rpc::v1::GetLedgerDataRequest& request = context.params;
    org::xrpl::rpc::v1::GetLedgerDataResponse response;
    grpc::Status status = grpc::Status::OK;

    std::shared_ptr<ReadView const> ledger;
    if (RPC::ledgerFromRequest(ledger, context))
    {
        grpc::Status errorStatus{
            grpc::StatusCode::NOT_FOUND, "ledger not found"};
        return {response, errorStatus};
    }

    ReadView::key_type key = ReadView::key_type();
    if (request.marker().size() != 0)
    {
        key = uint256::fromVoid(request.marker().data());
        if (key.size() != request.marker().size())
        {
            grpc::Status errorStatus{
                grpc::StatusCode::INVALID_ARGUMENT, "marker malformed"};
            return {response, errorStatus};
        }
    }

    auto e = ledger->sles.end();
    ReadView::key_type stopKey = ReadView::key_type();
    if (request.end_marker().size() != 0)
    {
        stopKey = uint256::fromVoid(request.end_marker().data());
        if (stopKey.size() != request.marker().size())
        {
            grpc::Status errorStatus{
                grpc::StatusCode::INVALID_ARGUMENT, "end marker malformed"};
            return {response, errorStatus};
        }
        e = ledger->sles.upper_bound(stopKey);
    }

    int maxLimit = RPC::Tuning::pageLength(true);

    for (auto i = ledger->sles.upper_bound(key); i != e; ++i)
    {
        auto sle = ledger->read(keylet::unchecked((*i)->key()));
        if (maxLimit-- <= 0)
        {
            // Stop processing before the current key.
            auto k = sle->key();
            --k;
            response.set_marker(k.data(), k.size());
            break;
        }
        auto stateObject = response.mutable_ledger_objects()->add_objects();
        Serializer s;
        sle->add(s);
        stateObject->set_data(s.peekData().data(), s.getLength());
        stateObject->set_key(sle->key().data(), sle->key().size());
    }
    return {response, status};
}
*/