mirror of
https://github.com/XRPLF/rippled.git
synced 2026-08-21 22:30:57 +00:00
83 lines
3.3 KiB
C++
83 lines
3.3 KiB
C++
#pragma once
|
|
|
|
#include <xrpl/basics/base_uint.h>
|
|
#include <xrpl/basics/safe_cast.h>
|
|
|
|
#include <type_traits>
|
|
|
|
namespace xrpl {
|
|
|
|
// Injected bare enumerators (xrpl::Delegable / xrpl::NotDelegable) are required by preprocessor
|
|
// tricks in tests and macro-generated code; enum class would break that.
|
|
// NOLINTNEXTLINE(cppcoreguidelines-use-enum-class)
|
|
enum Delegation { Delegable, NotDelegable };
|
|
|
|
/**
|
|
* Operations a transaction is permitted to perform, as a bitfield.
|
|
*
|
|
* These are declared per-transaction in transactions.macro (via
|
|
* TxSettings::privileges) and enforced in InvariantCheck.cpp.
|
|
*/
|
|
// Bitwise flags, 86 files, used in macros files
|
|
// NOLINTNEXTLINE(cppcoreguidelines-use-enum-class)
|
|
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
|
|
MayCreateMpt = 0x2000, // The transaction MAY create an MPT object, except for issuer.
|
|
};
|
|
|
|
constexpr Privilege
|
|
operator|(Privilege lhs, Privilege rhs)
|
|
{
|
|
return safeCast<Privilege>(
|
|
safeCast<std::underlying_type_t<Privilege>>(lhs) |
|
|
safeCast<std::underlying_type_t<Privilege>>(rhs));
|
|
}
|
|
|
|
/**
|
|
* Per-transaction metadata declared in transactions.macro.
|
|
*
|
|
* Every member has a default, so a transaction only needs to name the settings
|
|
* that differ from the common case. See the documentation at the top of
|
|
* transactions.macro for the authoring syntax.
|
|
*
|
|
* This is deliberately not a constexpr-friendly type: amendment identifiers are
|
|
* runtime-initialized `extern uint256 const` globals (see Feature.h), so a
|
|
* TxSettings can only be built at runtime.
|
|
*/
|
|
struct TxSettings
|
|
{
|
|
/**
|
|
* Whether an account may delegate this transaction to another account.
|
|
*/
|
|
Delegation delegable = Delegable;
|
|
|
|
/**
|
|
* The amendment gating this transaction, or uint256{} if always available.
|
|
*/
|
|
uint256 amendment{};
|
|
|
|
/**
|
|
* Operations this transaction is permitted to perform.
|
|
*/
|
|
Privilege privileges = NoPriv;
|
|
};
|
|
|
|
} // namespace xrpl
|