NoRippleCheck.hpp

#pragma once
 
#include "data/BackendInterface.hpp"
#include "rpc/Errors.hpp"
#include "rpc/JS.hpp"
#include "rpc/common/JsonBool.hpp"
#include "rpc/common/MetaProcessors.hpp"
#include "rpc/common/Modifiers.hpp"
#include "rpc/common/Specs.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/common/Validators.hpp"
 
#include <boost/json/array.hpp>
#include <boost/json/conversion.hpp>
#include <boost/json/value.hpp>
#include <xrpl/protocol/ErrorCodes.h>
#include <xrpl/protocol/jss.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace rpc {

class NoRippleCheckHandler {
    std::shared_ptr<BackendInterface> sharedPtrBackend_;
 
public:
    static constexpr auto kLIMIT_MIN = 1;
    static constexpr auto kLIMIT_MAX = 500;
    static constexpr auto kLIMIT_DEFAULT = 300;

    struct Output {
        std::string ledgerHash;
        uint32_t ledgerIndex{};
        std::vector<std::string> problems;
        // TODO: use better type than json
        std::optional<boost::json::array> transactions;
        bool validated = true;
    };

    struct Input {
        std::string account;
        bool roleGateway = false;
        std::optional<std::string> ledgerHash;
        std::optional<uint32_t> ledgerIndex;
        uint32_t limit = kLIMIT_DEFAULT;
        JsonBool transactions{false};
    };
 
    using Result = HandlerReturnType<Output>;

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

    static RpcSpecConstRef
    spec([[maybe_unused]] uint32_t apiVersion)
    {
        static auto const kRPC_SPEC_V1 = RpcSpec{
            {JS(account), validation::Required{}, validation::CustomValidators::accountValidator},
            {JS(role),
             validation::Required{},
             meta::WithCustomError{
                 validation::OneOf{"gateway", "user"},
                 Status{RippledError::rpcINVALID_PARAMS, "role field is invalid"}
             }},
            {JS(ledger_hash), validation::CustomValidators::uint256HexStringValidator},
            {JS(ledger_index), validation::CustomValidators::ledgerIndexValidator},
            {JS(limit),
             validation::Type<uint32_t>(),
             validation::Min(1u),
             modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}}
        };
 
        static auto const kRPC_SPEC = RpcSpec{
            kRPC_SPEC_V1,
            {
                {JS(transactions), validation::Type<bool>()},
            }
        };
 
        return apiVersion == 1 ? kRPC_SPEC_V1 : 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