Handler.h

#ifndef XRPL_RPC_HANDLER_H_INCLUDED
#define XRPL_RPC_HANDLER_H_INCLUDED
 
#include <xrpld/app/ledger/LedgerMaster.h>
#include <xrpld/app/misc/NetworkOPs.h>
#include <xrpld/rpc/RPCHandler.h>
#include <xrpld/rpc/Status.h>
#include <xrpld/rpc/detail/Tuning.h>
 
#include <xrpl/protocol/ApiVersion.h>
 
namespace Json {
class Object;
}
 
namespace ripple {
namespace RPC {
 
// Under what condition can we call this RPC?
enum Condition {
    NO_CONDITION = 0,
    NEEDS_NETWORK_CONNECTION = 1,
    NEEDS_CURRENT_LEDGER = 1 << 1,
    NEEDS_CLOSED_LEDGER = 1 << 2,
};
 
struct Handler
{
    template <class JsonValue>
    using Method = std::function<Status(JsonContext&, JsonValue&)>;
 
    char const* name_;
    Method<Json::Value> valueMethod_;
    Role role_;
    RPC::Condition condition_;
 
    unsigned minApiVer_ = apiMinimumSupportedVersion;
    unsigned maxApiVer_ = apiMaximumValidVersion;
};
 
Handler const*
getHandler(unsigned int version, bool betaEnabled, std::string const&);
 
template <class Value>
Json::Value
makeObjectValue(
    Value const& value,
    Json::StaticString const& field = jss::message)
{
    Json::Value result(Json::objectValue);
    result[field] = value;
    return result;
}
 
std::set<char const*>
getHandlerNames();
 
template <class T>
error_code_i
conditionMet(Condition condition_required, T& context)
{
    if (context.app.getOPs().isAmendmentBlocked() &&
        (condition_required != NO_CONDITION))
    {
        return rpcAMENDMENT_BLOCKED;
    }
 
    if (context.app.getOPs().isUNLBlocked() &&
        (condition_required != NO_CONDITION))
    {
        return rpcEXPIRED_VALIDATOR_LIST;
    }
 
    if ((condition_required != NO_CONDITION) &&
        (context.netOps.getOperatingMode() < OperatingMode::SYNCING))
    {
        JLOG(context.j.info()) << "Insufficient network mode for RPC: "
                               << context.netOps.strOperatingMode();
 
        if (context.apiVersion == 1)
            return rpcNO_NETWORK;
        return rpcNOT_SYNCED;
    }
 
    if (!context.app.config().standalone() &&
        condition_required != NO_CONDITION)
    {
        if (context.ledgerMaster.getValidatedLedgerAge() >
            Tuning::maxValidatedLedgerAge)
        {
            if (context.apiVersion == 1)
                return rpcNO_CURRENT;
            return rpcNOT_SYNCED;
        }
 
        auto const cID = context.ledgerMaster.getCurrentLedgerIndex();
        auto const vID = context.ledgerMaster.getValidLedgerIndex();
 
        if (cID + 10 < vID)
        {
            JLOG(context.j.debug())
                << "Current ledger ID(" << cID
                << ") is less than validated ledger ID(" << vID << ")";
            if (context.apiVersion == 1)
                return rpcNO_CURRENT;
            return rpcNOT_SYNCED;
        }
    }
 
    if ((condition_required != NO_CONDITION) &&
        !context.ledgerMaster.getClosedLedger())
    {
        if (context.apiVersion == 1)
            return rpcNO_CLOSED;
        return rpcNOT_SYNCED;
    }
 
    return rpcSUCCESS;
}
 
}  // namespace RPC
}  // namespace ripple
 
#endif