mirror of
https://github.com/Xahau/xahaud.git
synced 2026-06-04 01:06:37 +00:00
8dbc6db079
Add AMM functionality: - InstanceCreate - Deposit - Withdraw - Governance - Auctioning - payment engine integration To support this functionality, add: - New RPC method, `amm_info`, to fetch pool and LPT balances - AMM Root Account - trust line for each IOU AMM token - trust line to track Liquidity Provider Tokens (LPT) - `ltAMM` object The `ltAMM` object tracks: - fee votes - auction slot bids - AMM tokens pair - total outstanding tokens balance - `AMMID` to AMM `RootAccountID` mapping Add new classes to facilitate AMM integration into the payment engine. `BookStep` uses these classes to infer if AMM liquidity can be consumed. The AMM formula implementation uses the new Number class added in #4192. IOUAmount and STAmount use Number arithmetic. Add AMM unit tests for all features. AMM requires the following amendments: - featureAMM - fixUniversalNumber - featureFlowCross Notes: - Current trading fee threshold is 1% - AMM currency is generated by: 0x03 + 152 bits of sha256{cur1, cur2} - Current max AMM Offers is 30 --------- Co-authored-by: Howard Hinnant <howard.hinnant@gmail.com>
132 lines
4.0 KiB
C++
132 lines
4.0 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2023 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#include <ripple/protocol/AMMCore.h>
|
|
#include <ripple/protocol/Feature.h>
|
|
#include <ripple/protocol/Rules.h>
|
|
#include <ripple/protocol/STAmount.h>
|
|
#include <ripple/protocol/STObject.h>
|
|
#include <ripple/protocol/digest.h>
|
|
|
|
namespace ripple {
|
|
|
|
AccountID
|
|
ammAccountID(
|
|
std::uint16_t prefix,
|
|
uint256 const& parentHash,
|
|
uint256 const& ammID)
|
|
{
|
|
ripesha_hasher rsh;
|
|
auto const hash = sha512Half(prefix, parentHash, ammID);
|
|
rsh(hash.data(), hash.size());
|
|
return AccountID{static_cast<ripesha_hasher::result_type>(rsh)};
|
|
}
|
|
|
|
Currency
|
|
ammLPTCurrency(Currency const& cur1, Currency const& cur2)
|
|
{
|
|
// AMM LPToken is 0x03 plus 19 bytes of the hash
|
|
std::int32_t constexpr AMMCurrencyCode = 0x03;
|
|
auto const [minC, maxC] = std::minmax(cur1, cur2);
|
|
auto const hash = sha512Half(minC, maxC);
|
|
Currency currency;
|
|
*currency.begin() = AMMCurrencyCode;
|
|
std::copy(
|
|
hash.begin(), hash.begin() + currency.size() - 1, currency.begin() + 1);
|
|
return currency;
|
|
}
|
|
|
|
Issue
|
|
ammLPTIssue(
|
|
Currency const& cur1,
|
|
Currency const& cur2,
|
|
AccountID const& ammAccountID)
|
|
{
|
|
return Issue(ammLPTCurrency(cur1, cur2), ammAccountID);
|
|
}
|
|
|
|
NotTEC
|
|
invalidAMMAsset(
|
|
Issue const& issue,
|
|
std::optional<std::pair<Issue, Issue>> const& pair)
|
|
{
|
|
if (badCurrency() == issue.currency)
|
|
return temBAD_CURRENCY;
|
|
if (isXRP(issue) && issue.account.isNonZero())
|
|
return temBAD_ISSUER;
|
|
if (pair && issue != pair->first && issue != pair->second)
|
|
return temBAD_AMM_TOKENS;
|
|
return tesSUCCESS;
|
|
}
|
|
|
|
NotTEC
|
|
invalidAMMAssetPair(
|
|
Issue const& issue1,
|
|
Issue const& issue2,
|
|
std::optional<std::pair<Issue, Issue>> const& pair)
|
|
{
|
|
if (issue1 == issue2)
|
|
return temBAD_AMM_TOKENS;
|
|
if (auto const res = invalidAMMAsset(issue1, pair))
|
|
return res;
|
|
if (auto const res = invalidAMMAsset(issue2, pair))
|
|
return res;
|
|
return tesSUCCESS;
|
|
}
|
|
|
|
NotTEC
|
|
invalidAMMAmount(
|
|
STAmount const& amount,
|
|
std::optional<std::pair<Issue, Issue>> const& pair,
|
|
bool validZero)
|
|
{
|
|
if (auto const res = invalidAMMAsset(amount.issue(), pair))
|
|
return res;
|
|
if (amount < beast::zero || (!validZero && amount == beast::zero))
|
|
return temBAD_AMOUNT;
|
|
return tesSUCCESS;
|
|
}
|
|
|
|
std::optional<std::uint8_t>
|
|
ammAuctionTimeSlot(std::uint64_t current, STObject const& auctionSlot)
|
|
{
|
|
// It should be impossible for expiration to be < TOTAL_TIME_SLOT_SECS,
|
|
// but check just to be safe
|
|
auto const expiration = auctionSlot[sfExpiration];
|
|
assert(expiration >= TOTAL_TIME_SLOT_SECS);
|
|
if (expiration >= TOTAL_TIME_SLOT_SECS)
|
|
{
|
|
if (auto const start = expiration - TOTAL_TIME_SLOT_SECS;
|
|
current >= start)
|
|
{
|
|
if (auto const diff = current - start; diff < TOTAL_TIME_SLOT_SECS)
|
|
return diff / AUCTION_SLOT_INTERVAL_DURATION;
|
|
}
|
|
}
|
|
return std::nullopt;
|
|
}
|
|
|
|
bool
|
|
ammEnabled(Rules const& rules)
|
|
{
|
|
return rules.enabled(featureAMM) && rules.enabled(fixUniversalNumber);
|
|
}
|
|
|
|
} // namespace ripple
|