Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
LedgerIndex.hpp
1#pragma once
2
3#include "data/BackendInterface.hpp"
4#include "rpc/JS.hpp"
5#include "rpc/common/Specs.hpp"
6#include "rpc/common/Types.hpp"
7#include "rpc/common/Validators.hpp"
8
9#include <boost/json/conversion.hpp>
10#include <boost/json/value.hpp>
11#include <xrpl/protocol/jss.h>
12
13#include <cstdint>
14#include <memory>
15#include <optional>
16#include <string>
17
18namespace rpc {
19
25 std::shared_ptr<BackendInterface> sharedPtrBackend_;
26 static constexpr auto kDateFormat = "%Y-%m-%dT%TZ";
27
28public:
32 struct Output {
33 uint32_t ledgerIndex{};
34 std::string ledgerHash;
35 std::string closeTimeIso;
36 };
37
41 struct Input {
42 std::optional<std::string> date;
43 };
44
45 using Result = HandlerReturnType<Output>;
46
52 LedgerIndexHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
53 : sharedPtrBackend_(std::move(sharedPtrBackend))
54 {
55 }
56
63 static RpcSpecConstRef
64 spec([[maybe_unused]] uint32_t apiVersion)
65 {
66 static auto const kRpcSpec = RpcSpec{
67 {JS(date),
70 };
71 return kRpcSpec;
72 }
73
81 [[nodiscard]] Result
82 process(Input const& input, Context const& ctx) const;
83
84private:
91 friend void
92 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
93
100 friend Input
101 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
102};
103
104} // namespace rpc
friend void tag_invoke(boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Convert the Output to a JSON object.
Definition LedgerIndex.cpp:90
LedgerIndexHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new LedgerIndexHandler object.
Definition LedgerIndex.hpp:52
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition LedgerIndex.hpp:64
Result process(Input const &input, Context const &ctx) const
Process the LedgerIndex command.
Definition LedgerIndex.cpp:24
Validate that value can be converted to time according to the given format.
Definition Validators.hpp:288
This namespace contains all the RPC logic and handlers.
Definition AMMHelpers.cpp:17
RpcSpec const & RpcSpecConstRef
An alias for a const reference to RpcSpec.
Definition Specs.hpp:130
std::expected< OutputType, Status > HandlerReturnType
Return type for each individual handler.
Definition Types.hpp:62
Context of an RPC call.
Definition Types.hpp:99
A struct to hold the input data for the command.
Definition LedgerIndex.hpp:41
A struct to hold the output data of the command.
Definition LedgerIndex.hpp:32
Result type used to return responses or error statuses to the Webserver subsystem.
Definition Types.hpp:110
Represents a Specification of an entire RPC command.
Definition Specs.hpp:82
Validates that the type of the value is one of the given types.
Definition Validators.hpp:128