//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2022, 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/Errors.hpp" #include "rpc/JS.hpp" #include #include #include #include #include #include #include #include #include #include #include using namespace std; namespace { template struct overloadSet : Ts... { using Ts::operator()...; }; // explicit deduction guide (not needed as of C++20, but clang be clang) template overloadSet(Ts...) -> overloadSet; } // namespace namespace rpc { WarningInfo const& getWarningInfo(WarningCode code) { constexpr static WarningInfo infos[]{ {warnUNKNOWN, "Unknown warning"}, {warnRPC_CLIO, "This is a clio server. clio only serves validated data. If you want to talk to rippled, include " "'ledger_index':'current' in your request"}, {warnRPC_OUTDATED, "This server may be out of date"}, {warnRPC_RATE_LIMIT, "You are about to be rate limited"}, {warnRPC_DEPRECATED, "Some fields from your request are deprecated. Please check the documentation at " "https://xrpl.org/docs/references/http-websocket-apis/ and update your request."} }; auto matchByCode = [code](auto const& info) { return info.code == code; }; if (auto it = find_if(begin(infos), end(infos), matchByCode); it != end(infos)) return *it; throw(out_of_range("Invalid WarningCode")); } boost::json::object makeWarning(WarningCode code) { auto json = boost::json::object{}; auto const& info = getWarningInfo(code); json["id"] = code; json["message"] = info.message; return json; } ClioErrorInfo const& getErrorInfo(ClioError code) { constexpr static ClioErrorInfo infos[]{ {ClioError::rpcMALFORMED_CURRENCY, "malformedCurrency", "Malformed currency."}, {ClioError::rpcMALFORMED_REQUEST, "malformedRequest", "Malformed request."}, {ClioError::rpcMALFORMED_OWNER, "malformedOwner", "Malformed owner."}, {ClioError::rpcMALFORMED_ADDRESS, "malformedAddress", "Malformed address."}, {ClioError::rpcINVALID_HOT_WALLET, "invalidHotWallet", "Invalid hot wallet."}, {ClioError::rpcUNKNOWN_OPTION, "unknownOption", "Unknown option."}, {ClioError::rpcFIELD_NOT_FOUND_TRANSACTION, "fieldNotFoundTransaction", "Missing field."}, {ClioError::rpcMALFORMED_ORACLE_DOCUMENT_ID, "malformedDocumentID", "Malformed oracle_document_id."}, // special system errors {ClioError::rpcINVALID_API_VERSION, JS(invalid_API_version), "Invalid API version."}, {ClioError::rpcCOMMAND_IS_MISSING, JS(missingCommand), "Method is not specified or is not a string."}, {ClioError::rpcCOMMAND_NOT_STRING, "commandNotString", "Method is not a string."}, {ClioError::rpcCOMMAND_IS_EMPTY, "emptyCommand", "Method is an empty string."}, {ClioError::rpcPARAMS_UNPARSEABLE, "paramsUnparseable", "Params must be an array holding exactly one object."}, // etl related errors {ClioError::etlCONNECTION_ERROR, "connectionError", "Couldn't connect to rippled."}, {ClioError::etlREQUEST_ERROR, "requestError", "Error sending request to rippled."}, {ClioError::etlREQUEST_TIMEOUT, "timeout", "Request to rippled timed out."}, {ClioError::etlINVALID_RESPONSE, "invalidResponse", "Rippled returned an invalid response."} }; auto matchByCode = [code](auto const& info) { return info.code == code; }; if (auto it = find_if(begin(infos), end(infos), matchByCode); it != end(infos)) return *it; throw(out_of_range("Invalid error code")); } boost::json::object makeError(RippledError err, std::optional customError, std::optional customMessage) { boost::json::object json; auto const& info = ripple::RPC::get_error_info(err); json["error"] = customError.value_or(info.token.c_str()).data(); json["error_code"] = static_cast(err); json["error_message"] = customMessage.value_or(info.message.c_str()).data(); json["status"] = "error"; json["type"] = "response"; return json; } boost::json::object makeError(ClioError err, std::optional customError, std::optional customMessage) { boost::json::object json; auto const& info = getErrorInfo(err); json["error"] = customError.value_or(info.error); json["error_code"] = static_cast(info.code); json["error_message"] = customMessage.value_or(info.message); json["status"] = "error"; json["type"] = "response"; return json; } boost::json::object makeError(Status const& status) { auto wrapOptional = [](string_view const& str) { return str.empty() ? nullopt : make_optional(str); }; auto res = visit( overloadSet{ [&status, &wrapOptional](RippledError err) { if (err == ripple::rpcUNKNOWN) return boost::json::object{{"error", status.message}, {"type", "response"}, {"status", "error"}}; return makeError(err, wrapOptional(status.error), wrapOptional(status.message)); }, [&status, &wrapOptional](ClioError err) { return makeError(err, wrapOptional(status.error), wrapOptional(status.message)); }, }, status.code ); if (status.extraInfo) { for (auto& [key, value] : status.extraInfo.value()) res[key] = value; } return res; } } // namespace rpc