Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
AccountMPTokens.hpp
1#pragma once
2
3#include "data/BackendInterface.hpp"
4#include "rpc/Errors.hpp"
5#include "rpc/JS.hpp"
6#include "rpc/common/Checkers.hpp"
7#include "rpc/common/MetaProcessors.hpp"
8#include "rpc/common/Modifiers.hpp"
9#include "rpc/common/Specs.hpp"
10#include "rpc/common/Types.hpp"
11#include "rpc/common/Validators.hpp"
12
13#include <boost/json/conversion.hpp>
14#include <boost/json/value.hpp>
15#include <xrpl/protocol/AccountID.h>
16#include <xrpl/protocol/ErrorCodes.h>
17#include <xrpl/protocol/STLedgerEntry.h>
18#include <xrpl/protocol/jss.h>
19
20#include <cstdint>
21#include <optional>
22#include <string>
23#include <vector>
24
25namespace rpc {
26
32 // dependencies
33 std::shared_ptr<BackendInterface> sharedPtrBackend_;
34
35public:
36 static constexpr auto kLIMIT_MIN = 10;
37 static constexpr auto kLIMIT_MAX = 400;
38 static constexpr auto kLIMIT_DEFAULT = 200;
39
44 std::string MPTokenID;
45 std::string account;
46 std::string MPTokenIssuanceID;
47 uint64_t MPTAmount{};
48 std::optional<uint64_t> lockedAmount;
49
50 std::optional<bool> mptLocked;
51 std::optional<bool> mptAuthorized;
52 };
53
57 struct Output {
58 std::string account;
59 std::vector<MPTokenResponse> mpts;
60 std::string ledgerHash;
61 uint32_t ledgerIndex{};
62 bool validated = true;
63 std::optional<std::string> marker;
64 uint32_t limit{};
65 };
66
70 struct Input {
71 std::string account;
72 std::optional<std::string> ledgerHash;
73 std::optional<uint32_t> ledgerIndex;
74 uint32_t limit = kLIMIT_DEFAULT;
75 std::optional<std::string> marker;
76 };
77
78 using Result = HandlerReturnType<Output>;
79
85 AccountMPTokensHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
86 : sharedPtrBackend_(std::move(sharedPtrBackend))
87 {
88 }
89
96 static RpcSpecConstRef
97 spec([[maybe_unused]] uint32_t apiVersion)
98 {
99 static auto const kRPC_SPEC = RpcSpec{
100 {JS(account),
104 Status(RippledError::rpcACT_MALFORMED)
105 }},
107 {JS(limit),
109 validation::Min(1u),
110 modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
113 {JS(ledger), check::Deprecated{}},
114 };
115
116 return kRPC_SPEC;
117 }
118
126 Result
127 process(Input const& input, Context const& ctx) const;
128
129private:
130 static void
131 addMPToken(std::vector<MPTokenResponse>& mpts, ripple::SLE const& sle);
132
133private:
140 friend void
141 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
142
149 friend Input
150 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
151
158 friend void
159 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, MPTokenResponse const& mptoken);
160};
161
162} // namespace rpc
AccountMPTokensHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountMPTokensHandler object.
Definition AccountMPTokens.hpp:85
Result process(Input const &input, Context const &ctx) const
Process the AccountMPTokens command.
Definition AccountMPTokens.cpp:58
friend void tag_invoke(boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Convert the Output to a JSON object.
Definition AccountMPTokens.cpp:144
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition AccountMPTokens.hpp:97
Check for a deprecated fields.
Definition Checkers.hpp:44
A meta-processor that wraps a validator and produces a custom error in case the wrapped validator fai...
Definition MetaProcessors.hpp:152
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 AccountMPTokens.hpp:70
A struct to hold data for one MPToken response.
Definition AccountMPTokens.hpp:43
A struct to hold the output data of the command.
Definition AccountMPTokens.hpp:57
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
A status returned from any RPC handler.
Definition Errors.hpp:65
static CustomValidator accountValidator
Provides a commonly used validator for accounts.
Definition Validators.hpp:504
static CustomValidator accountMarkerValidator
Provides a commonly used validator for markers.
Definition Validators.hpp:519
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