Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
AccountOffers.hpp
1#pragma once
2
3#include "data/BackendInterface.hpp"
4#include "rpc/JS.hpp"
5#include "rpc/common/Checkers.hpp"
6#include "rpc/common/Modifiers.hpp"
7#include "rpc/common/Specs.hpp"
8#include "rpc/common/Types.hpp"
9#include "rpc/common/Validators.hpp"
10
11#include <boost/json/conversion.hpp>
12#include <boost/json/value.hpp>
13#include <xrpl/protocol/STAmount.h>
14#include <xrpl/protocol/STLedgerEntry.h>
15#include <xrpl/protocol/jss.h>
16
17#include <cstdint>
18#include <memory>
19#include <optional>
20#include <string>
21#include <vector>
22
23namespace rpc {
24
31 std::shared_ptr<BackendInterface> sharedPtrBackend_;
32
33public:
34 static constexpr auto kLIMIT_MIN = 10;
35 static constexpr auto kLIMIT_MAX = 400;
36 static constexpr auto kLIMIT_DEFAULT = 200;
37
41 struct Offer {
42 uint32_t flags{};
43 uint32_t seq{};
44 ripple::STAmount takerGets;
45 ripple::STAmount takerPays;
46 std::string quality;
47 std::optional<uint32_t> expiration;
48 };
49
53 struct Output {
54 std::string account;
55 std::string ledgerHash;
56 uint32_t ledgerIndex{};
57 std::vector<Offer> offers;
58 std::optional<std::string> marker;
59 // validated should be sent via framework
60 bool validated = true;
61 };
62
66 struct Input {
67 std::string account;
68 std::optional<std::string> ledgerHash;
69 std::optional<uint32_t> ledgerIndex;
70 uint32_t limit = kLIMIT_DEFAULT;
71 std::optional<std::string> marker;
72 };
73
74 using Result = HandlerReturnType<Output>;
75
81 AccountOffersHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
82 : sharedPtrBackend_(std::move(sharedPtrBackend))
83 {
84 }
85
92 static RpcSpecConstRef
93 spec([[maybe_unused]] uint32_t apiVersion)
94 {
95 static auto const kRPC_SPEC = RpcSpec{
100 {JS(limit),
102 validation::Min(1u),
103 modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
104 {JS(ledger), check::Deprecated{}},
105 {JS(strict), check::Deprecated{}},
106 };
107
108 return kRPC_SPEC;
109 }
110
118 Result
119 process(Input const& input, Context const& ctx) const;
120
121private:
122 static void
123 addOffer(std::vector<Offer>& offers, ripple::SLE const& offerSle);
124
131 friend void
132 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
133
140 friend Input
141 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
142
149 friend void
150 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Offer const& offer);
151};
152} // 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 AccountOffers.cpp:105
Result process(Input const &input, Context const &ctx) const
Process the AccountOffers command.
Definition AccountOffers.cpp:51
AccountOffersHandler(std::shared_ptr< BackendInterface > sharedPtrBackend)
Construct a new AccountOffersHandler object.
Definition AccountOffers.hpp:81
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition AccountOffers.hpp:93
Check for a deprecated fields.
Definition Checkers.hpp:44
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 AccountOffers.hpp:66
A struct to hold data for one offer response.
Definition AccountOffers.hpp:41
A struct to hold the output data of the command.
Definition AccountOffers.hpp:53
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
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