mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-18 18:15:50 +00:00
621df422a7
* Add AMM bid/create/deposit/swap/withdraw/vote invariants:
- Deposit, Withdrawal invariants: `sqrt(asset1Balance * asset2Balance) >= LPTokens`.
- Bid: `sqrt(asset1Balance * asset2Balance) > LPTokens` and the pool balances don't change.
- Create: `sqrt(asset1Balance * assetBalance2) == LPTokens`.
- Swap: `asset1BalanceAfter * asset2BalanceAfter >= asset1BalanceBefore * asset2BalanceBefore`
and `LPTokens` don't change.
- Vote: `LPTokens` and pool balances don't change.
- All AMM and swap transactions: amounts and tokens are greater than zero, except on withdrawal if all tokens
are withdrawn.
* Add AMM deposit and withdraw rounding to ensure AMM invariant:
- On deposit, tokens out are rounded downward and deposit amount is rounded upward.
- On withdrawal, tokens in are rounded upward and withdrawal amount is rounded downward.
* Add Order Book Offer invariant to verify consumed amounts. Consumed amounts are less than the offer.
* Fix Bid validation. `AuthAccount` can't have duplicate accounts or the submitter account.
135 lines
3.5 KiB
C++
135 lines
3.5 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 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.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef RIPPLE_LEDGER_RULES_H_INCLUDED
|
|
#define RIPPLE_LEDGER_RULES_H_INCLUDED
|
|
|
|
#include <xrpl/basics/base_uint.h>
|
|
#include <xrpl/beast/hash/uhash.h>
|
|
#include <xrpl/protocol/STVector256.h>
|
|
|
|
#include <unordered_set>
|
|
|
|
namespace ripple {
|
|
|
|
bool
|
|
isFeatureEnabled(uint256 const& feature);
|
|
|
|
class DigestAwareReadView;
|
|
|
|
/** Rules controlling protocol behavior. */
|
|
class Rules
|
|
{
|
|
private:
|
|
class Impl;
|
|
|
|
// Carrying impl by shared_ptr makes Rules comparatively cheap to pass
|
|
// by value.
|
|
std::shared_ptr<Impl const> impl_;
|
|
|
|
public:
|
|
Rules(Rules const&) = default;
|
|
|
|
Rules(Rules&&) = default;
|
|
|
|
Rules&
|
|
operator=(Rules const&) = default;
|
|
|
|
Rules&
|
|
operator=(Rules&&) = default;
|
|
|
|
Rules() = delete;
|
|
|
|
/** Construct an empty rule set.
|
|
|
|
These are the rules reflected by
|
|
the genesis ledger.
|
|
*/
|
|
explicit Rules(std::unordered_set<uint256, beast::uhash<>> const& presets);
|
|
|
|
private:
|
|
// Allow a friend function to construct Rules.
|
|
friend Rules
|
|
makeRulesGivenLedger(
|
|
DigestAwareReadView const& ledger,
|
|
Rules const& current);
|
|
|
|
friend Rules
|
|
makeRulesGivenLedger(
|
|
DigestAwareReadView const& ledger,
|
|
std::unordered_set<uint256, beast::uhash<>> const& presets);
|
|
|
|
Rules(
|
|
std::unordered_set<uint256, beast::uhash<>> const& presets,
|
|
std::optional<uint256> const& digest,
|
|
STVector256 const& amendments);
|
|
|
|
std::unordered_set<uint256, beast::uhash<>> const&
|
|
presets() const;
|
|
|
|
public:
|
|
/** Returns `true` if a feature is enabled. */
|
|
bool
|
|
enabled(uint256 const& feature) const;
|
|
|
|
/** Returns `true` if two rule sets are identical.
|
|
|
|
@note This is for diagnostics.
|
|
*/
|
|
bool
|
|
operator==(Rules const&) const;
|
|
|
|
bool
|
|
operator!=(Rules const& other) const;
|
|
};
|
|
|
|
std::optional<Rules> const&
|
|
getCurrentTransactionRules();
|
|
|
|
void
|
|
setCurrentTransactionRules(std::optional<Rules> r);
|
|
|
|
/** RAII class to set and restore the current transaction rules
|
|
*/
|
|
class CurrentTransactionRulesGuard
|
|
{
|
|
public:
|
|
explicit CurrentTransactionRulesGuard(Rules r)
|
|
: saved_(getCurrentTransactionRules())
|
|
{
|
|
setCurrentTransactionRules(std::move(r));
|
|
}
|
|
|
|
~CurrentTransactionRulesGuard()
|
|
{
|
|
setCurrentTransactionRules(saved_);
|
|
}
|
|
|
|
CurrentTransactionRulesGuard() = delete;
|
|
CurrentTransactionRulesGuard(CurrentTransactionRulesGuard const&) = delete;
|
|
CurrentTransactionRulesGuard&
|
|
operator=(CurrentTransactionRulesGuard const&) = delete;
|
|
|
|
private:
|
|
std::optional<Rules> saved_;
|
|
};
|
|
|
|
} // namespace ripple
|
|
#endif
|