mirror of
https://github.com/XRPLF/clio.git
synced 2025-11-19 19:25:53 +00:00
120 lines
3.5 KiB
C++
120 lines
3.5 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of clio: https://github.com/XRPLF/clio
|
|
Copyright (c) 2024, 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.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#pragma once
|
|
#include "data/BackendInterface.hpp"
|
|
#include "rpc/JS.hpp"
|
|
#include "rpc/common/Specs.hpp"
|
|
#include "rpc/common/Types.hpp"
|
|
#include "rpc/common/Validators.hpp"
|
|
|
|
#include <boost/json/conversion.hpp>
|
|
#include <boost/json/value.hpp>
|
|
#include <xrpl/protocol/jss.h>
|
|
|
|
#include <cstdint>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
|
|
namespace rpc {
|
|
|
|
/**
|
|
* @brief The ledger_index method fetches the lastest closed ledger before the given date.
|
|
*
|
|
*/
|
|
class LedgerIndexHandler {
|
|
std::shared_ptr<BackendInterface> sharedPtrBackend_;
|
|
static constexpr auto DATE_FORMAT = "%Y-%m-%dT%TZ";
|
|
|
|
public:
|
|
/**
|
|
* @brief A struct to hold the output data of the command
|
|
*/
|
|
struct Output {
|
|
uint32_t ledgerIndex{};
|
|
std::string ledgerHash;
|
|
std::string closeTimeIso;
|
|
};
|
|
|
|
/**
|
|
* @brief A struct to hold the input data for the command
|
|
*/
|
|
struct Input {
|
|
std::optional<std::string> date;
|
|
};
|
|
|
|
using Result = HandlerReturnType<Output>;
|
|
|
|
/**
|
|
* @brief Construct a new LedgerIndexHandler object
|
|
*
|
|
* @param sharedPtrBackend The backend to use
|
|
*/
|
|
LedgerIndexHandler(std::shared_ptr<BackendInterface> const& sharedPtrBackend) : sharedPtrBackend_(sharedPtrBackend)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the API specification for the command
|
|
*
|
|
* @param apiVersion The api version to return the spec for
|
|
* @return The spec for the given apiVersion
|
|
*/
|
|
static RpcSpecConstRef
|
|
spec([[maybe_unused]] uint32_t apiVersion)
|
|
{
|
|
static auto const rpcSpec = RpcSpec{
|
|
{JS(date), validation::Type<std::string>{}, validation::TimeFormatValidator{DATE_FORMAT}},
|
|
};
|
|
return rpcSpec;
|
|
}
|
|
|
|
/**
|
|
* @brief Process the LedgerIndex command
|
|
*
|
|
* @param input The input data for the command
|
|
* @param ctx The context of the request
|
|
* @return The result of the operation
|
|
*/
|
|
Result
|
|
process(Input input, Context const& ctx) const;
|
|
|
|
private:
|
|
/**
|
|
* @brief Convert the Output to a JSON object
|
|
*
|
|
* @param [out] jv The JSON object to convert to
|
|
* @param output The output to convert
|
|
*/
|
|
friend void
|
|
tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
|
|
|
|
/**
|
|
* @brief Convert a JSON object to Input type
|
|
*
|
|
* @param jv The JSON object to convert
|
|
* @return Input parsed from the JSON object
|
|
*/
|
|
friend Input
|
|
tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
|
|
};
|
|
|
|
} // namespace rpc
|