mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
89 lines
1.7 KiB
C++
89 lines
1.7 KiB
C++
#ifndef XRPL_PROTOCOL_RATE_H_INCLUDED
|
|
#define XRPL_PROTOCOL_RATE_H_INCLUDED
|
|
|
|
#include <xrpl/beast/utility/instrumentation.h>
|
|
#include <xrpl/protocol/STAmount.h>
|
|
|
|
#include <boost/operators.hpp>
|
|
|
|
#include <cstdint>
|
|
#include <ostream>
|
|
|
|
namespace ripple {
|
|
|
|
/** Represents a transfer rate
|
|
|
|
Transfer rates are specified as fractions of 1 billion.
|
|
For example, a transfer rate of 1% is represented as
|
|
1,010,000,000.
|
|
*/
|
|
struct Rate : private boost::totally_ordered<Rate>
|
|
{
|
|
std::uint32_t value;
|
|
|
|
Rate() = delete;
|
|
|
|
explicit Rate(std::uint32_t rate) : value(rate)
|
|
{
|
|
}
|
|
};
|
|
|
|
inline bool
|
|
operator==(Rate const& lhs, Rate const& rhs) noexcept
|
|
{
|
|
return lhs.value == rhs.value;
|
|
}
|
|
|
|
inline bool
|
|
operator<(Rate const& lhs, Rate const& rhs) noexcept
|
|
{
|
|
return lhs.value < rhs.value;
|
|
}
|
|
|
|
inline std::ostream&
|
|
operator<<(std::ostream& os, Rate const& rate)
|
|
{
|
|
os << rate.value;
|
|
return os;
|
|
}
|
|
|
|
STAmount
|
|
multiply(STAmount const& amount, Rate const& rate);
|
|
|
|
STAmount
|
|
multiplyRound(STAmount const& amount, Rate const& rate, bool roundUp);
|
|
|
|
STAmount
|
|
multiplyRound(
|
|
STAmount const& amount,
|
|
Rate const& rate,
|
|
Asset const& asset,
|
|
bool roundUp);
|
|
|
|
STAmount
|
|
divide(STAmount const& amount, Rate const& rate);
|
|
|
|
STAmount
|
|
divideRound(STAmount const& amount, Rate const& rate, bool roundUp);
|
|
|
|
STAmount
|
|
divideRound(
|
|
STAmount const& amount,
|
|
Rate const& rate,
|
|
Asset const& asset,
|
|
bool roundUp);
|
|
|
|
namespace nft {
|
|
/** Given a transfer fee (in basis points) convert it to a transfer rate. */
|
|
Rate
|
|
transferFeeAsRate(std::uint16_t fee);
|
|
|
|
} // namespace nft
|
|
|
|
/** A transfer rate signifying a 1:1 exchange */
|
|
extern Rate const parityRate;
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|