Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
BookChanges.hpp
1#pragma once
2
3#include "data/BackendInterface.hpp"
5#include "rpc/JS.hpp"
6#include "rpc/common/Specs.hpp"
7#include "rpc/common/Types.hpp"
8#include "rpc/common/Validators.hpp"
9
10#include <boost/json/conversion.hpp>
11#include <boost/json/value.hpp>
12#include <xrpl/protocol/jss.h>
13
14#include <cstdint>
15#include <memory>
16#include <optional>
17#include <string>
18#include <vector>
19
20namespace rpc {
21
28 std::shared_ptr<BackendInterface> sharedPtrBackend_;
29
30public:
34 struct Output {
35 std::string ledgerHash;
36 uint32_t ledgerIndex{};
37 uint32_t ledgerTime{};
38 std::vector<BookChange> bookChanges;
39 bool validated = true;
40 };
41
47 struct Input {
48 std::optional<std::string> ledgerHash;
49 std::optional<uint32_t> ledgerIndex;
50 };
51
52 using Result = HandlerReturnType<Output>;
53
59 BookChangesHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
60 : sharedPtrBackend_(std::move(sharedPtrBackend))
61 {
62 }
63
70 static RpcSpecConstRef
71 spec([[maybe_unused]] uint32_t apiVersion)
72 {
73 static auto const kRPC_SPEC = RpcSpec{
76 };
77
78 return kRPC_SPEC;
79 }
80
88 Result
89 process(Input const& input, Context const& ctx) const;
90
91private:
98 friend void
99 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
100
107 friend Input
108 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
109};
110
111} // namespace rpc
Result process(Input const &input, Context const &ctx) const
Process the BookChanges command.
Definition BookChanges.cpp:26
BookChangesHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new BookChangesHandler object.
Definition BookChanges.hpp:59
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition BookChanges.hpp:71
friend void tag_invoke(boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Convert the Output to a JSON object.
Definition BookChanges.cpp:52
This namespace contains all the RPC logic and handlers.
Definition AMMHelpers.cpp:18
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
A struct to hold the input data for the command.
Definition BookChanges.hpp:47
A struct to hold the output data of the command.
Definition BookChanges.hpp:34
Context of an RPC call.
Definition Types.hpp:99
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
static CustomValidator ledgerIndexValidator
Provides a commonly used validator for ledger index.
Definition Validators.hpp:489
static CustomValidator uint256HexStringValidator
Provides a commonly used validator for uint256 hex string.
Definition Validators.hpp:551