xrpld
Loading...
Searching...
No Matches
AMMCore.cpp
1#include <xrpl/protocol/AMMCore.h>
2
3#include <xrpl/basics/base_uint.h>
4#include <xrpl/beast/utility/Zero.h>
5#include <xrpl/beast/utility/instrumentation.h>
6#include <xrpl/protocol/AccountID.h>
7#include <xrpl/protocol/Asset.h>
8#include <xrpl/protocol/Concepts.h>
9#include <xrpl/protocol/Issue.h>
10#include <xrpl/protocol/MPTIssue.h>
11#include <xrpl/protocol/SField.h>
12#include <xrpl/protocol/STAmount.h>
13#include <xrpl/protocol/STInteger.h> // IWYU pragma: keep
14#include <xrpl/protocol/STObject.h>
15#include <xrpl/protocol/TER.h>
16#include <xrpl/protocol/UintTypes.h>
17#include <xrpl/protocol/digest.h>
18
19#include <algorithm>
20#include <cstdint>
21#include <optional>
22#include <utility>
23#include <variant>
24
25namespace xrpl {
26
28ammLPTCurrency(Asset const& asset1, Asset const& asset2)
29{
30 // AMM LPToken is 0x03 plus 19 bytes of the hash
31 static constexpr std::int32_t kAmmCurrencyCode = 0x03;
32 auto const& [minA, maxA] = std::minmax(asset1, asset2);
33 UInt256 const hash = std::visit(
34 [](auto&& issue1, auto&& issue2) {
35 auto const fromIss = []<ValidIssueType T>(T const& issue) {
36 if constexpr (std::is_same_v<T, Issue>)
37 return issue.currency;
38 if constexpr (std::is_same_v<T, MPTIssue>)
39 return issue.getMptID();
40 };
41 return sha512Half(fromIss(issue1), fromIss(issue2));
42 },
43 minA.value(),
44 maxA.value());
45 Currency currency;
46 *currency.begin() = kAmmCurrencyCode;
47 std::copy(hash.begin(), hash.begin() + currency.size() - 1, currency.begin() + 1);
48 return currency;
49}
50
51Issue
52ammLPTIssue(Asset const& asset1, Asset const& asset2, AccountID const& ammAccountID)
53{
54 return Issue(ammLPTCurrency(asset1, asset2), ammAccountID);
55}
56
59{
60 auto const err = asset.visit(
61 [](MPTIssue const& issue) -> std::optional<NotTEC> {
62 if (issue.getIssuer() == beast::kZero)
63 return temBAD_MPT;
64 return std::nullopt;
65 },
66 [](Issue const& issue) -> std::optional<NotTEC> {
67 if (badCurrency() == issue.currency)
68 return temBAD_CURRENCY;
69 if (isXRP(issue) && issue.getIssuer().isNonZero())
70 return temBAD_ISSUER;
71 return std::nullopt;
72 });
73 if (err)
74 return *err;
75 if (pair && asset != pair->first && asset != pair->second)
76 return temBAD_AMM_TOKENS;
77 return tesSUCCESS;
78}
79
82 Asset const& asset1,
83 Asset const& asset2,
85{
86 if (asset1 == asset2)
87 return temBAD_AMM_TOKENS;
88 if (auto const res = invalidAMMAsset(asset1, pair))
89 return res;
90 if (auto const res = invalidAMMAsset(asset2, pair))
91 return res;
92 return tesSUCCESS;
93}
94
97 STAmount const& amount,
99 bool validZero)
100{
101 if (auto const res = invalidAMMAsset(amount.asset(), pair))
102 return res;
103 if (amount < beast::kZero || (!validZero && amount == beast::kZero))
104 return temBAD_AMOUNT;
105 return tesSUCCESS;
106}
107
109ammAuctionTimeSlot(std::uint64_t current, STObject const& auctionSlot)
110{
111 // It should be impossible for expiration to be < TOTAL_TIME_SLOT_SECS,
112 // but check just to be safe
113 auto const expiration = auctionSlot[sfExpiration];
114 XRPL_ASSERT(expiration >= kTotalTimeSlotSecs, "xrpl::ammAuctionTimeSlot : minimum expiration");
115 if (expiration >= kTotalTimeSlotSecs)
116 {
117 if (auto const start = expiration - kTotalTimeSlotSecs; current >= start)
118 {
119 if (auto const diff = current - start; diff < kTotalTimeSlotSecs)
120 return diff / kAuctionSlotIntervalDuration;
121 }
122 }
123 return std::nullopt;
124}
125
126} // namespace xrpl
constexpr auto visit(Visitors &&... visitors) const -> decltype(auto)
Definition Asset.h:117
bool isNonZero() const
Definition base_uint.h:568
iterator begin()
Definition base_uint.h:128
static constexpr std::size_t size()
Definition base_uint.h:549
A currency issued by an account.
Definition Issue.h:18
AccountID const & getIssuer() const
Definition MPTIssue.cpp:29
Asset const & asset() const
Definition STAmount.h:496
T copy(T... args)
T is_same_v
T minmax(T... args)
constexpr Zero kZero
Definition Zero.h:30
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:5
NotTEC invalidAMMAmount(STAmount const &amount, std::optional< std::pair< Asset, Asset > > const &pair=std::nullopt, bool validZero=false)
Validate the amount.
Definition AMMCore.cpp:96
constexpr std::uint32_t kTotalTimeSlotSecs
Definition AMMCore.h:19
bool isXRP(AccountID const &c)
Definition AccountID.h:84
NotTEC invalidAMMAssetPair(Asset const &asset1, Asset const &asset2, std::optional< std::pair< Asset, Asset > > const &pair=std::nullopt)
Definition AMMCore.cpp:81
BaseUInt< 160, detail::CurrencyTag > Currency
Currency is a hash representing a specific currency.
Definition UintTypes.h:42
Currency ammLPTCurrency(Asset const &asset1, Asset const &asset2)
Calculate Liquidity Provider Token (LPT) Currency.
Definition AMMCore.cpp:28
BaseUInt< 256 > UInt256
Definition base_uint.h:581
TERSubset< CanCvtToNotTEC > NotTEC
Definition TER.h:617
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition AccountID.h:34
@ temBAD_ISSUER
Definition TER.h:81
@ temBAD_CURRENCY
Definition TER.h:78
@ temBAD_MPT
Definition TER.h:133
@ temBAD_AMM_TOKENS
Definition TER.h:117
@ temBAD_AMOUNT
Definition TER.h:77
std::optional< std::uint8_t > ammAuctionTimeSlot(std::uint64_t current, STObject const &auctionSlot)
Get time slot of the auction slot.
Definition AMMCore.cpp:109
Issue ammLPTIssue(Asset const &asset1, Asset const &asset2, AccountID const &ammAccountID)
Calculate LPT Issue from AMM asset pair.
Definition AMMCore.cpp:52
Currency const & badCurrency()
We deliberately disallow the currency that looks like "XRP" because too many people were using it ins...
NotTEC invalidAMMAsset(Asset const &asset, std::optional< std::pair< Asset, Asset > > const &pair=std::nullopt)
Definition AMMCore.cpp:58
@ tesSUCCESS
Definition TER.h:253
constexpr std::uint32_t kAuctionSlotIntervalDuration
Definition AMMCore.h:25
Sha512HalfHasher::result_type sha512Half(Args const &... args)
Returns the SHA512-Half of a series of objects.
Definition digest.h:215
T visit(T... args)