Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
NFTsByIssuer.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
26 std::shared_ptr<BackendInterface> sharedPtrBackend_;
27
28public:
29 static constexpr auto kLIMIT_MIN = 1;
30 static constexpr auto kLIMIT_MAX = 100;
31 static constexpr auto kLIMIT_DEFAULT = 50;
32
36 struct Output {
37 boost::json::array nfts;
38 uint32_t ledgerIndex;
39 std::string issuer;
40 bool validated = true;
41 std::optional<uint32_t> nftTaxon;
42 uint32_t limit;
43 std::optional<std::string> marker;
44 };
45
49 struct Input {
50 std::string issuer;
51 std::optional<uint32_t> nftTaxon;
52 std::optional<std::string> ledgerHash;
53 std::optional<uint32_t> ledgerIndex;
54 std::optional<std::string> marker;
55 std::optional<uint32_t> limit;
56 };
57
58 using Result = HandlerReturnType<Output>;
59
65 NFTsByIssuerHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
66 : sharedPtrBackend_(std::move(sharedPtrBackend))
67 {
68 }
69
76 static RpcSpecConstRef
77 spec([[maybe_unused]] uint32_t apiVersion)
78 {
79 static auto const kRPC_SPEC = RpcSpec{
81 {JS(nft_taxon), validation::Type<uint32_t>{}},
84 {JS(limit),
87 modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
89 };
90
91 return kRPC_SPEC;
92 }
93
101 Result
102 process(Input const& input, Context const& ctx) const;
103
104private:
111 friend void
112 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
113
120 friend Input
121 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
122};
123} // 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 NFTsByIssuer.cpp:94
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition NFTsByIssuer.hpp:77
NFTsByIssuerHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new NFTsByIssuerHandler object.
Definition NFTsByIssuer.hpp:65
Result process(Input const &input, Context const &ctx) const
Process the NFTsByIssuer command.
Definition NFTsByIssuer.cpp:31
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
Context of an RPC call.
Definition Types.hpp:99
A struct to hold the input data for the command.
Definition NFTsByIssuer.hpp:49
A struct to hold the output data of the command.
Definition NFTsByIssuer.hpp:36
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