Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
AccountObjects.hpp
1#pragma once
2
3#include "data/BackendInterface.hpp"
4#include "rpc/common/SpecBackend.hpp"
5#include "rpc/common/Types.hpp"
6
7#include <boost/json/conversion.hpp>
8#include <boost/json/value.hpp>
9#include <rpcspec/handlers/account_objects/Types.hpp>
10#include <xrpl/protocol/STLedgerEntry.h>
11
12#include <cstdint>
13#include <memory>
14#include <optional>
15#include <string>
16#include <utility>
17#include <vector>
18
19namespace rpc {
20
28class AccountObjectsHandler : public rpc::HandlerFor<rpc::spec::handlers::account_objects::Input> {
29 // dependencies
30 std::shared_ptr<BackendInterface> sharedPtrBackend_;
31
32public:
33 static constexpr auto kLimitMin = rpc::spec::handlers::account_objects::kLimitMin;
34 static constexpr auto kLimitMax = rpc::spec::handlers::account_objects::kLimitMax;
35 static constexpr auto kLimitDefault = rpc::spec::handlers::account_objects::kLimitDefault;
36
40 struct Output {
41 std::string account;
42 std::string ledgerHash;
43 uint32_t ledgerIndex{};
44 std::optional<std::string> marker;
45 uint32_t limit{};
46 std::vector<xrpl::SLE> accountObjects;
47 bool validated = true;
48 };
49
50 using Result = HandlerReturnType<Output>;
51
57 AccountObjectsHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
58 : sharedPtrBackend_(std::move(sharedPtrBackend))
59 {
60 }
61
69 [[nodiscard]] Result
70 process(Input const& input, Context const& ctx) const;
71
72private:
79 friend void
80 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
81};
82
83} // namespace rpc
AccountObjectsHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountObjectsHandler object.
Definition AccountObjects.hpp:57
Result process(Input const &input, Context const &ctx) const
Process the AccountObjects command.
Definition AccountObjects.cpp:35
friend void tag_invoke(boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Convert the Output to a JSON object.
Definition AccountObjects.cpp:146
This namespace contains all the RPC logic and handlers.
Definition AMMHelpers.cpp:17
std::expected< OutputType, Status > HandlerReturnType
Return type for each individual handler.
Definition Types.hpp:61
spec::HandlerFor< InputT, boost::json::value > HandlerFor
The spec-driven base every typed handler inherits.
Definition SpecBackend.hpp:24
A struct to hold the output data of the command.
Definition AccountObjects.hpp:40
Context of an RPC call.
Definition Types.hpp:98
Result type used to return responses or error statuses to the Webserver subsystem.
Definition Types.hpp:109