Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
BookOffers.hpp
1#pragma once
2
3#include "data/AmendmentCenterInterface.hpp"
4#include "data/BackendInterface.hpp"
5#include "rpc/Errors.hpp"
6#include "rpc/JS.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/array.hpp>
14#include <boost/json/conversion.hpp>
15#include <boost/json/object.hpp>
16#include <boost/json/value.hpp>
17#include <xrpl/protocol/AccountID.h>
18#include <xrpl/protocol/ErrorCodes.h>
19#include <xrpl/protocol/UintTypes.h>
20#include <xrpl/protocol/jss.h>
21
22#include <cstdint>
23#include <memory>
24#include <optional>
25#include <string>
26
27namespace rpc {
28
36 std::shared_ptr<BackendInterface> sharedPtrBackend_;
37 std::shared_ptr<data::AmendmentCenterInterface const> amendmentCenter_;
38
39public:
40 static constexpr auto kLIMIT_MIN = 1;
41 static constexpr auto kLIMIT_MAX = 100;
42 static constexpr auto kLIMIT_DEFAULT = 60;
43
47 struct Output {
48 std::string ledgerHash;
49 uint32_t ledgerIndex;
50 boost::json::array offers;
51 bool validated = true;
52 };
53
60 struct Input {
61 std::optional<std::string> ledgerHash;
62 std::optional<uint32_t> ledgerIndex;
63 uint32_t limit = kLIMIT_DEFAULT;
64 std::optional<ripple::AccountID> taker;
65 ripple::Currency paysCurrency;
66 ripple::Currency getsCurrency;
67 // accountID will be filled by input converter, if no issuer is given, will use XRP issuer
68 ripple::AccountID paysID = ripple::xrpAccount();
69 ripple::AccountID getsID = ripple::xrpAccount();
70 std::optional<std::string> domain;
71 };
72
73 using Result = HandlerReturnType<Output>;
74
82 std::shared_ptr<BackendInterface> sharedPtrBackend,
83 std::shared_ptr<data::AmendmentCenterInterface const> const& amendmentCenter
84 )
85 : sharedPtrBackend_(std::move(sharedPtrBackend)), amendmentCenter_{amendmentCenter}
86 {
87 }
88
95 static RpcSpecConstRef
96 spec([[maybe_unused]] uint32_t apiVersion)
97 {
98 static auto const kRPC_SPEC = RpcSpec{
99 {JS(taker_gets),
103 {JS(currency),
107 Status(RippledError::rpcDST_AMT_MALFORMED)
108 }},
109 {JS(issuer),
112 Status(RippledError::rpcDST_ISR_MALFORMED)
113 }}
114 }},
115 {JS(taker_pays),
119 {JS(currency),
123 Status(RippledError::rpcSRC_CUR_MALFORMED)
124 }},
125 {JS(issuer),
128 Status(RippledError::rpcSRC_ISR_MALFORMED)
129 }}
130 }},
131 // return INVALID_PARAMS if account format is wrong for "taker"
132 {JS(taker),
135 Status(RippledError::rpcINVALID_PARAMS, "Invalid field 'taker'.")
136 }},
137 {JS(domain),
140 Status(RippledError::rpcDOMAIN_MALFORMED, "Unable to parse domain.")
141 },
144 Status(RippledError::rpcDOMAIN_MALFORMED, "Unable to parse domain.")
145 }},
146 {JS(limit),
148 validation::Min(1u),
149 modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
152 };
153
154 return kRPC_SPEC;
155 }
156
164 Result
165 process(Input const& input, Context const& ctx) const;
166
167private:
174 friend void
175 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
176
183 friend Input
184 tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
185};
186} // 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 BookOffers.cpp:71
BookOffersHandler(std::shared_ptr< BackendInterface > sharedPtrBackend, std::shared_ptr< data::AmendmentCenterInterface const > const &amendmentCenter)
Construct a new BookOffersHandler object.
Definition BookOffers.hpp:81
Result process(Input const &input, Context const &ctx) const
Process the BookOffers command.
Definition BookOffers.cpp:28
static RpcSpecConstRef spec(uint32_t apiVersion)
Returns the API specification for the command.
Definition BookOffers.hpp:96
A meta-processor that acts as a spec for a sub-object/section.
Definition MetaProcessors.hpp:24
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 BookOffers.hpp:60
A struct to hold the output data of the command.
Definition BookOffers.hpp:47
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 currencyValidator
Provides a commonly used validator for currency, including standard currency code and token code.
Definition Validators.hpp:557
static CustomValidator issuerValidator
Provides a commonly used validator for issuer type.
Definition Validators.hpp:564
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