mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-29 15:37:57 +00:00
1a7f824b89
The invariant check system had grown into a single monolithic file pair containing 24 invariant checker classes. The large `InvariantCheck.cpp` file was a frequent source of merge conflicts and difficult to navigate. This refactoring improves maintainability and readability with zero behavioral changes. In particular, this change: - Splits `InvariantCheck.h` and `InvariantCheck.cpp` into 10 focused header/source pairs organized by domain under a new `invariants/` subdirectory. - Extracts the shared `Privilege` enum and `hasPrivilege()` function into a dedicated `InvariantCheckPrivilege.h` header, so domain-specific files can reference them independently.
61 lines
2.6 KiB
C++
61 lines
2.6 KiB
C++
#pragma once
|
|
|
|
#include <xrpl/protocol/STTx.h>
|
|
|
|
#include <type_traits>
|
|
|
|
namespace xrpl {
|
|
|
|
/*
|
|
assert(enforce)
|
|
|
|
There are several asserts (or XRPL_ASSERTs) in invariant check files that check
|
|
a variable named `enforce` when an invariant fails. At first glance, those
|
|
asserts may look incorrect, but they are not.
|
|
|
|
Those asserts take advantage of two facts:
|
|
1. `asserts` are not (normally) executed in release builds.
|
|
2. Invariants should *never* fail, except in tests that specifically modify
|
|
the open ledger to break them.
|
|
|
|
This makes `assert(enforce)` sort of a second-layer of invariant enforcement
|
|
aimed at _developers_. It's designed to fire if a developer writes code that
|
|
violates an invariant, and runs it in unit tests or a develop build that _does
|
|
not have the relevant amendments enabled_. It's intentionally a pain in the neck
|
|
so that bad code gets caught and fixed as early as possible.
|
|
*/
|
|
|
|
enum Privilege {
|
|
noPriv = 0x0000, // The transaction can not do any of the enumerated operations
|
|
createAcct = 0x0001, // The transaction can create a new ACCOUNT_ROOT object.
|
|
createPseudoAcct = 0x0002, // The transaction can create a pseudo account,
|
|
// which implies createAcct
|
|
mustDeleteAcct = 0x0004, // The transaction must delete an ACCOUNT_ROOT object
|
|
mayDeleteAcct = 0x0008, // The transaction may delete an ACCOUNT_ROOT
|
|
// object, but does not have to
|
|
overrideFreeze = 0x0010, // The transaction can override some freeze rules
|
|
changeNFTCounts = 0x0020, // The transaction can mint or burn an NFT
|
|
createMPTIssuance = 0x0040, // The transaction can create a new MPT issuance
|
|
destroyMPTIssuance = 0x0080, // The transaction can destroy an MPT issuance
|
|
mustAuthorizeMPT = 0x0100, // The transaction MUST create or delete an MPT
|
|
// object (except by issuer)
|
|
mayAuthorizeMPT = 0x0200, // The transaction MAY create or delete an MPT
|
|
// object (except by issuer)
|
|
mayDeleteMPT = 0x0400, // The transaction MAY delete an MPT object. May not create.
|
|
mustModifyVault = 0x0800, // The transaction must modify, delete or create, a vault
|
|
mayModifyVault = 0x1000, // The transaction MAY modify, delete or create, a vault
|
|
};
|
|
|
|
constexpr Privilege
|
|
operator|(Privilege lhs, Privilege rhs)
|
|
{
|
|
return safe_cast<Privilege>(
|
|
safe_cast<std::underlying_type_t<Privilege>>(lhs) |
|
|
safe_cast<std::underlying_type_t<Privilege>>(rhs));
|
|
}
|
|
|
|
bool
|
|
hasPrivilege(STTx const& tx, Privilege priv);
|
|
|
|
} // namespace xrpl
|