Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
AccountNFTs.hpp
1#pragma once
2
3#include "data/BackendInterface.hpp"
4#include "rpc/JS.hpp"
5#include "rpc/common/Modifiers.hpp"
6#include "rpc/common/Specs.hpp"
7#include "rpc/common/Types.hpp"
8#include "rpc/common/Validators.hpp"
9
10#include <boost/json/array.hpp>
11#include <boost/json/conversion.hpp>
12#include <boost/json/value.hpp>
13#include <xrpl/protocol/jss.h>
14
15#include <cstdint>
16#include <memory>
17#include <optional>
18#include <string>
19
20namespace rpc {
21
28 std::shared_ptr<BackendInterface> sharedPtrBackend_;
29
30public:
31 static constexpr auto kLIMIT_MIN = 20;
32 static constexpr auto kLIMIT_MAX = 400;
33 static constexpr auto kLIMIT_DEFAULT = 100;
34
38 struct Output {
39 std::string account;
40 std::string ledgerHash;
41 uint32_t ledgerIndex;
42 // TODO: use better type than json
43 boost::json::array nfts;
44 uint32_t limit;
45 std::optional<std::string> marker;
46 bool validated = true;
47 };
48
52 struct Input {
53 std::string account;
54 std::optional<std::string> ledgerHash;
55 std::optional<uint32_t> ledgerIndex;
56 uint32_t limit = kLIMIT_DEFAULT; // Limit the number of token pages to retrieve. [20,400]
57 std::optional<std::string> marker;
58 };
59
60 using Result = HandlerReturnType<Output>;
61
67 AccountNFTsHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
68 : sharedPtrBackend_(std::move(sharedPtrBackend))
69 {
70 }
71
78 static RpcSpecConstRef
79 spec([[maybe_unused]] uint32_t apiVersion)
80 {
81 static auto const kRPC_SPEC = RpcSpec{
86 {JS(limit),
89 modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
90 };
91
92 return kRPC_SPEC;
93 }
94
102 Result
103 process(Input const& input, Context const& ctx) const;
104
105private:
112 friend void
113 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
114
121 friend Input
122 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
123};
124
125} // namespace rpc
Result process(Input const &input, Context const &ctx) const
Process the AccountNFTs command.
Definition AccountNFTs.cpp:34
friend void tag_invoke(boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Convert the Output to a JSON object.
Definition AccountNFTs.cpp:127
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition AccountNFTs.hpp:79
AccountNFTsHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountNFTsHandler object.
Definition AccountNFTs.hpp:67
Clamp value between min and max.
Definition Modifiers.hpp:23
Validate that value is equal or greater than the specified min.
Definition Validators.hpp:205
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 AccountNFTs.hpp:52
A struct to hold the output data of the command.
Definition AccountNFTs.hpp:38
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 accountValidator
Provides a commonly used validator for accounts.
Definition Validators.hpp:504
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
A validator that simply requires a field to be present.
Definition Validators.hpp:28
Validates that the type of the value is one of the given types.
Definition Validators.hpp:128