mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-19 18:45:52 +00:00
1d42c4f6de
Per XLS-0095, we are taking steps to rename ripple(d) to xrpl(d). This change specifically removes all copyright notices referencing Ripple, XRPLF, and certain affiliated contributors upon mutual agreement, so the notice in the LICENSE.md file applies throughout. Copyright notices referencing external contributions remain as-is. Duplicate verbiage is also removed.
116 lines
2.5 KiB
C++
116 lines
2.5 KiB
C++
#ifndef XRPL_LEDGER_RULES_H_INCLUDED
|
|
#define XRPL_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
|