Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
AccountMPTokenIssuances.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 <memory>
22#include <optional>
23#include <string>
24#include <vector>
25
26namespace rpc {
27
33 // dependencies
34 std::shared_ptr<BackendInterface> sharedPtrBackend_;
35
36public:
37 static constexpr auto kLIMIT_MIN = 10;
38 static constexpr auto kLIMIT_MAX = 400;
39 static constexpr auto kLIMIT_DEFAULT = 200;
40
45 std::string MPTokenIssuanceID;
46 std::string issuer;
47 uint32_t sequence{};
48
49 std::optional<uint16_t> transferFee;
50 std::optional<uint8_t> assetScale;
51
52 std::optional<std::uint64_t> maximumAmount;
53 std::optional<std::uint64_t> outstandingAmount;
54 std::optional<std::uint64_t> lockedAmount;
55 std::optional<std::string> mptokenMetadata;
56 std::optional<std::string> domainID;
57
58 std::optional<bool> mptLocked;
59 std::optional<bool> mptCanLock;
60 std::optional<bool> mptRequireAuth;
61 std::optional<bool> mptCanEscrow;
62 std::optional<bool> mptCanTrade;
63 std::optional<bool> mptCanTransfer;
64 std::optional<bool> mptCanClawback;
65
66 std::optional<bool> mptCanMutateCanLock;
67 std::optional<bool> mptCanMutateRequireAuth;
68 std::optional<bool> mptCanMutateCanEscrow;
69 std::optional<bool> mptCanMutateCanTrade;
70 std::optional<bool> mptCanMutateCanTransfer;
71 std::optional<bool> mptCanMutateCanClawback;
72 std::optional<bool> mptCanMutateMetadata;
73 std::optional<bool> mptCanMutateTransferFee;
74 };
75
79 struct Output {
80 std::string account;
81 std::vector<MPTokenIssuanceResponse> issuances;
82 std::string ledgerHash;
83 uint32_t ledgerIndex{};
84 bool validated = true;
85 std::optional<std::string> marker;
86 uint32_t limit{};
87 };
88
92 struct Input {
93 std::string account;
94 std::optional<std::string> ledgerHash;
95 std::optional<uint32_t> ledgerIndex;
96 uint32_t limit = kLIMIT_DEFAULT;
97 std::optional<std::string> marker;
98 };
99
100 using Result = HandlerReturnType<Output>;
101
107 AccountMPTokenIssuancesHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
108 : sharedPtrBackend_(std::move(sharedPtrBackend))
109 {
110 }
111
118 static RpcSpecConstRef
119 spec([[maybe_unused]] uint32_t apiVersion)
120 {
121 static auto const kRPC_SPEC = RpcSpec{
122 {JS(account),
126 Status(RippledError::rpcACT_MALFORMED)
127 }},
129 {JS(limit),
131 validation::Min(1u),
132 modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
135 {JS(ledger), check::Deprecated{}},
136 };
137
138 return kRPC_SPEC;
139 }
140
148 Result
149 process(Input const& input, Context const& ctx) const;
150
151private:
152 static void
153 addMPTokenIssuance(
154 std::vector<MPTokenIssuanceResponse>& issuances,
155 ripple::SLE const& sle,
156 ripple::AccountID const& account
157 );
158
159private:
166 friend void
167 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
168
175 friend Input
176 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
177
184 friend void
186 boost::json::value_from_tag,
187 boost::json::value& jv,
188 MPTokenIssuanceResponse const& issuance
189 );
190};
191
192} // namespace rpc
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition AccountMPTokenIssuances.hpp:119
AccountMPTokenIssuancesHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountMPTokenIssuancesHandler object.
Definition AccountMPTokenIssuances.hpp:107
Result process(Input const &input, Context const &ctx) const
Process the AccountMPTokenIssuances command.
Definition AccountMPTokenIssuances.cpp:101
friend void tag_invoke(boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Convert the Output to a JSON object.
Definition AccountMPTokenIssuances.cpp:190
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 AccountMPTokenIssuances.hpp:92
A struct to hold data for one MPTokenIssuance response.
Definition AccountMPTokenIssuances.hpp:44
A struct to hold the output data of the command.
Definition AccountMPTokenIssuances.hpp:79
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