AMMCore.h

#ifndef XRPL_PROTOCOL_AMMCORE_H_INCLUDED
#define XRPL_PROTOCOL_AMMCORE_H_INCLUDED
 
#include <xrpl/basics/Number.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Issue.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/UintTypes.h>
 
namespace ripple {
 
std::uint16_t constexpr TRADING_FEE_THRESHOLD = 1000;  // 1%
 
// Auction slot
std::uint32_t constexpr TOTAL_TIME_SLOT_SECS = 24 * 3600;
std::uint16_t constexpr AUCTION_SLOT_TIME_INTERVALS = 20;
std::uint16_t constexpr AUCTION_SLOT_MAX_AUTH_ACCOUNTS = 4;
std::uint32_t constexpr AUCTION_SLOT_FEE_SCALE_FACTOR = 100000;
std::uint32_t constexpr AUCTION_SLOT_DISCOUNTED_FEE_FRACTION = 10;
std::uint32_t constexpr AUCTION_SLOT_MIN_FEE_FRACTION = 25;
std::uint32_t constexpr AUCTION_SLOT_INTERVAL_DURATION =
    TOTAL_TIME_SLOT_SECS / AUCTION_SLOT_TIME_INTERVALS;
 
// Votes
std::uint16_t constexpr VOTE_MAX_SLOTS = 8;
std::uint32_t constexpr VOTE_WEIGHT_SCALE_FACTOR = 100000;
 
class STObject;
class STAmount;
class Rules;
 
Currency
ammLPTCurrency(Currency const& cur1, Currency const& cur2);
 
Issue
ammLPTIssue(
    Currency const& cur1,
    Currency const& cur2,
    AccountID const& ammAccountID);
 
NotTEC
invalidAMMAmount(
    STAmount const& amount,
    std::optional<std::pair<Issue, Issue>> const& pair = std::nullopt,
    bool validZero = false);
 
NotTEC
invalidAMMAsset(
    Issue const& issue,
    std::optional<std::pair<Issue, Issue>> const& pair = std::nullopt);
 
NotTEC
invalidAMMAssetPair(
    Issue const& issue1,
    Issue const& issue2,
    std::optional<std::pair<Issue, Issue>> const& pair = std::nullopt);
 
std::optional<std::uint8_t>
ammAuctionTimeSlot(std::uint64_t current, STObject const& auctionSlot);
 
bool
ammEnabled(Rules const&);
 
inline Number
getFee(std::uint16_t tfee)
{
    return Number{tfee} / AUCTION_SLOT_FEE_SCALE_FACTOR;
}
 
inline Number
feeMult(std::uint16_t tfee)
{
    return 1 - getFee(tfee);
}
 
inline Number
feeMultHalf(std::uint16_t tfee)
{
    return 1 - getFee(tfee) / 2;
}
 
}  // namespace ripple
 
#endif  // XRPL_PROTOCOL_AMMCORE_H_INCLUDED