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/common/SpecBackend.hpp"
5#include "rpc/common/Types.hpp"
6
7#include <boost/json/conversion.hpp>
8#include <boost/json/value.hpp>
9#include <rpcspec/handlers/account_mptoken_issuances/Types.hpp>
10#include <xrpl/protocol/AccountID.h>
11#include <xrpl/protocol/STLedgerEntry.h>
12
13#include <cstdint>
14#include <memory>
15#include <optional>
16#include <string>
17#include <utility>
18#include <vector>
19
20namespace rpc {
21
27 : public rpc::HandlerFor<rpc::spec::handlers::account_mptoken_issuances::Input> {
28 // dependencies
29 std::shared_ptr<BackendInterface> sharedPtrBackend_;
30
31public:
32 static constexpr auto kLimitMin = rpc::spec::handlers::account_mptoken_issuances::kLimitMin;
33 static constexpr auto kLimitMax = rpc::spec::handlers::account_mptoken_issuances::kLimitMax;
34 static constexpr auto kLimitDefault =
35 rpc::spec::handlers::account_mptoken_issuances::kLimitDefault;
36
41 std::string mpTokenIssuanceId;
42 std::string issuer;
43 uint32_t sequence{};
44
45 std::optional<uint16_t> transferFee;
46 std::optional<uint8_t> assetScale;
47
48 std::optional<std::uint64_t> maximumAmount;
49 std::optional<std::uint64_t> outstandingAmount;
50 std::optional<std::uint64_t> lockedAmount;
51 std::optional<std::string> mptokenMetadata;
52 std::optional<std::string> domainID;
53
54 std::optional<bool> mptLocked;
55 std::optional<bool> mptCanLock;
56 std::optional<bool> mptRequireAuth;
57 std::optional<bool> mptCanEscrow;
58 std::optional<bool> mptCanTrade;
59 std::optional<bool> mptCanTransfer;
60 std::optional<bool> mptCanClawback;
61
62 std::optional<bool> mptImmutableCanLock;
63 std::optional<bool> mptImmutableRequireAuth;
64 std::optional<bool> mptImmutableCanEscrow;
65 std::optional<bool> mptImmutableCanTrade;
66 std::optional<bool> mptImmutableCanTransfer;
67 std::optional<bool> mptImmutableCanClawback;
68 std::optional<bool> mptImmutableCanHoldConfidentialBalance;
69 std::optional<bool> mptImmutableMetadata;
70 std::optional<bool> mptImmutableTransferFee;
71
72 std::optional<bool> mptCanHoldConfidentialBalance;
73 std::optional<std::uint64_t> confidentialOutstandingAmount;
74 std::optional<std::string> issuerEncryptionKey;
75 std::optional<std::string> auditorEncryptionKey;
76 };
77
81 struct Output {
82 std::string account;
83 std::vector<MPTokenIssuanceResponse> issuances;
84 std::string ledgerHash;
85 uint32_t ledgerIndex{};
86 bool validated = true;
87 std::optional<std::string> marker;
88 uint32_t limit{};
89 };
90
91 using Result = HandlerReturnType<Output>;
92
98 AccountMPTokenIssuancesHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
99 : sharedPtrBackend_(std::move(sharedPtrBackend))
100 {
101 }
102
110 [[nodiscard]] Result
111 process(Input const& input, Context const& ctx) const;
112
113private:
114 static void
115 addMPTokenIssuance(
116 std::vector<MPTokenIssuanceResponse>& issuances,
117 xrpl::SLE const& sle,
118 xrpl::AccountID const& account
119 );
120
121private:
128 friend void
129 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
130
137 friend void
139 boost::json::value_from_tag,
140 boost::json::value& jv,
141 MPTokenIssuanceResponse const& issuance
142 );
143};
144
145} // namespace rpc
AccountMPTokenIssuancesHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountMPTokenIssuancesHandler object.
Definition AccountMPTokenIssuances.hpp:98
Result process(Input const &input, Context const &ctx) const
Process the AccountMPTokenIssuances command.
Definition AccountMPTokenIssuances.cpp:118
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:181
This namespace contains all the RPC logic and handlers.
Definition AMMHelpers.cpp:17
std::expected< OutputType, Status > HandlerReturnType
Return type for each individual handler.
Definition Types.hpp:61
spec::HandlerFor< InputT, boost::json::value > HandlerFor
The spec-driven base every typed handler inherits.
Definition SpecBackend.hpp:24
A struct to hold data for one MPTokenIssuance response.
Definition AccountMPTokenIssuances.hpp:40
A struct to hold the output data of the command.
Definition AccountMPTokenIssuances.hpp:81
Context of an RPC call.
Definition Types.hpp:98
Result type used to return responses or error statuses to the Webserver subsystem.
Definition Types.hpp:109