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 kLimitMin = 10;
37 static constexpr auto kLimitMax = 400;
38 static constexpr auto kLimitDefault = 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 std::optional<std::string> confidentialBalanceInbox;
54 std::optional<std::string> confidentialBalanceSpending;
55 std::optional<uint32_t> confidentialBalanceVersion;
56 std::optional<std::string> issuerEncryptedBalance;
57 std::optional<std::string> auditorEncryptedBalance;
58 std::optional<std::string> holderEncryptionKey;
59 };
60
64 struct Output {
65 std::string account;
66 std::vector<MPTokenResponse> mpts;
67 std::string ledgerHash;
68 uint32_t ledgerIndex{};
69 bool validated = true;
70 std::optional<std::string> marker;
71 uint32_t limit{};
72 };
73
77 struct Input {
78 std::string account;
79 std::optional<std::string> ledgerHash;
80 std::optional<uint32_t> ledgerIndex;
81 uint32_t limit = kLimitDefault;
82 std::optional<std::string> marker;
83 };
84
85 using Result = HandlerReturnType<Output>;
86
92 AccountMPTokensHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
93 : sharedPtrBackend_(std::move(sharedPtrBackend))
94 {
95 }
96
103 static RpcSpecConstRef
104 spec([[maybe_unused]] uint32_t apiVersion)
105 {
106 static auto const kRpcSpec = RpcSpec{
107 {JS(account),
111 Status(RippledError::RpcActMalformed)
112 }},
114 {JS(limit),
116 validation::Min(1u),
117 modifiers::Clamp<int32_t>{kLimitMin, kLimitMax}},
120 {JS(ledger), check::Deprecated{}},
121 };
122
123 return kRpcSpec;
124 }
125
133 [[nodiscard]] Result
134 process(Input const& input, Context const& ctx) const;
135
136private:
137 static void
138 addMPToken(std::vector<MPTokenResponse>& mpts, xrpl::SLE const& sle);
139
140private:
147 friend void
148 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
149
156 friend Input
157 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
158
165 friend void
166 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, MPTokenResponse const& mptoken);
167};
168
169} // namespace rpc
AccountMPTokensHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountMPTokensHandler object.
Definition AccountMPTokens.hpp:92
Result process(Input const &input, Context const &ctx) const
Process the AccountMPTokens command.
Definition AccountMPTokens.cpp:84
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:177
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition AccountMPTokens.hpp:104
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:17
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:77
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:64
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:73
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