//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2023, 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. */ //============================================================================== #include "rpc/handlers/LedgerData.hpp" #include "data/Types.hpp" #include "rpc/Errors.hpp" #include "rpc/JS.hpp" #include "rpc/RPCHelpers.hpp" #include "rpc/common/Types.hpp" #include "util/Assert.hpp" #include "util/LedgerUtils.hpp" #include "util/log/Logger.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace rpc { LedgerDataHandler::Result LedgerDataHandler::process(Input const& input, Context const& ctx) const { // marker must be int if outOfOrder is true if (input.outOfOrder && input.marker) return Error{Status{RippledError::rpcINVALID_PARAMS, "outOfOrderMarkerNotInt"}}; if (!input.outOfOrder && input.diffMarker) return Error{Status{RippledError::rpcINVALID_PARAMS, "markerNotString"}}; auto const range = sharedPtrBackend_->fetchLedgerRange(); ASSERT(range.has_value(), "LedgerData's ledger range must be available"); auto const expectedLgrInfo = getLedgerHeaderFromHashOrSeq( *sharedPtrBackend_, ctx.yield, input.ledgerHash, input.ledgerIndex, range->maxSequence ); if (!expectedLgrInfo.has_value()) return Error{expectedLgrInfo.error()}; auto const& lgrInfo = expectedLgrInfo.value(); Output output; // no marker -> first call, return header information if ((!input.marker) && (!input.diffMarker)) { output.header = toJson(lgrInfo, input.binary, ctx.apiVersion); } else { if (input.marker && !sharedPtrBackend_->fetchLedgerObject(*(input.marker), lgrInfo.seq, ctx.yield)) return Error{Status{RippledError::rpcINVALID_PARAMS, "markerDoesNotExist"}}; } output.ledgerHash = ripple::strHex(lgrInfo.hash); output.ledgerIndex = lgrInfo.seq; auto const start = std::chrono::system_clock::now(); std::vector results; if (input.diffMarker) { // keep the same logic as previous implementation auto diff = sharedPtrBackend_->fetchLedgerDiff(*(input.diffMarker), ctx.yield); std::vector keys; for (auto& [key, object] : diff) { if (object.empty()) keys.push_back(key); } auto objs = sharedPtrBackend_->fetchLedgerObjects(keys, lgrInfo.seq, ctx.yield); for (size_t i = 0; i < objs.size(); ++i) { auto& obj = objs[i]; if (!obj.empty()) results.push_back({keys[i], std::move(obj)}); } if (*(input.diffMarker) > lgrInfo.seq) output.diffMarker = *(input.diffMarker) - 1; } else { // limit's limitation is different based on binary or json // framework can not handler the check right now, adjust the value here auto const limit = std::min(input.limit, input.binary ? LedgerDataHandler::kLIMIT_BINARY : LedgerDataHandler::kLIMIT_JSON); auto page = sharedPtrBackend_->fetchLedgerPage(input.marker, lgrInfo.seq, limit, input.outOfOrder, ctx.yield); results = std::move(page.objects); if (page.cursor) { output.marker = ripple::strHex(*(page.cursor)); } else if (input.outOfOrder) { output.diffMarker = range->maxSequence; } } auto const end = std::chrono::system_clock::now(); LOG(log_.debug()) << "Number of results = " << results.size() << " fetched in " << std::chrono::duration_cast(end - start).count() << " microseconds"; output.states.reserve(results.size()); for (auto const& [key, object] : results) { ripple::STLedgerEntry const sle{ripple::SerialIter{object.data(), object.size()}, key}; // note the filter is after limit is applied, same as rippled if (input.type == ripple::LedgerEntryType::ltANY || sle.getType() == input.type) { if (input.binary) { boost::json::object entry; entry[JS(data)] = ripple::serializeHex(sle); entry[JS(index)] = ripple::to_string(sle.key()); output.states.push_back(std::move(entry)); } else { output.states.push_back(toJson(sle)); } } } if (input.outOfOrder) output.cacheFull = sharedPtrBackend_->cache().isFull(); auto const end2 = std::chrono::system_clock::now(); LOG(log_.debug()) << "Number of results = " << results.size() << " serialized in " << std::chrono::duration_cast(end2 - end).count() << " microseconds"; return output; } void tag_invoke(boost::json::value_from_tag, boost::json::value& jv, LedgerDataHandler::Output const& output) { auto obj = boost::json::object{ {JS(ledger_hash), output.ledgerHash}, {JS(ledger_index), output.ledgerIndex}, {JS(validated), output.validated}, {JS(state), output.states}, }; if (output.header) obj[JS(ledger)] = *(output.header); if (output.cacheFull) obj["cache_full"] = *(output.cacheFull); if (output.diffMarker) { obj[JS(marker)] = *(output.diffMarker); } else if (output.marker) { obj[JS(marker)] = *(output.marker); } jv = std::move(obj); } LedgerDataHandler::Input tag_invoke(boost::json::value_to_tag, boost::json::value const& jv) { auto input = LedgerDataHandler::Input{}; auto const& jsonObject = jv.as_object(); if (jsonObject.contains(JS(binary))) { input.binary = jsonObject.at(JS(binary)).as_bool(); input.limit = input.binary ? LedgerDataHandler::kLIMIT_BINARY : LedgerDataHandler::kLIMIT_JSON; } if (jsonObject.contains(JS(limit))) input.limit = jsonObject.at(JS(limit)).as_int64(); if (jsonObject.contains("out_of_order")) input.outOfOrder = jsonObject.at("out_of_order").as_bool(); if (jsonObject.contains(JS(marker))) { if (jsonObject.at(JS(marker)).is_string()) { input.marker = ripple::uint256{boost::json::value_to(jsonObject.at(JS(marker))).data()}; } else { input.diffMarker = jsonObject.at(JS(marker)).as_int64(); } } if (jsonObject.contains(JS(ledger_hash))) input.ledgerHash = boost::json::value_to(jsonObject.at(JS(ledger_hash))); if (jsonObject.contains(JS(ledger_index))) { if (!jsonObject.at(JS(ledger_index)).is_string()) { input.ledgerIndex = jsonObject.at(JS(ledger_index)).as_int64(); } else if (jsonObject.at(JS(ledger_index)).as_string() != "validated") { input.ledgerIndex = std::stoi(boost::json::value_to(jsonObject.at(JS(ledger_index)))); } } if (jsonObject.contains(JS(type))) input.type = util::LedgerTypes::getLedgerEntryTypeFromStr(boost::json::value_to(jv.at(JS(type)))); return input; } } // namespace rpc