xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
protocol
Permissions.h
1
#pragma once
2
3
#include <xrpl/basics/base_uint.h>
4
#include <xrpl/protocol/Rules.h>
5
#include <xrpl/protocol/SOTemplate.h>
6
#include <xrpl/protocol/TxFormats.h>
7
#include <xrpl/protocol/TxSettings.h>
8
9
#include <
cstdint
>
10
#include <
functional
>
11
#include <
optional
>
12
#include <
string
>
13
#include <
unordered_map
>
14
#include <
unordered_set
>
15
#include <
vector
>
16
17
namespace
xrpl
{
18
19
class
STTx
;
20
28
// Macro-generated, complex
29
// NOLINTBEGIN(readability-trailing-comma) the macro supplies the trailing comma
30
// NOLINTNEXTLINE(cppcoreguidelines-use-enum-class)
31
enum
GranularPermissionType
:
std::uint32_t
{
32
#pragma push_macro("GRANULAR_PERMISSION")
33
#undef GRANULAR_PERMISSION
34
35
#define GRANULAR_PERMISSION(name, txType, value, ...) name = (value),
36
37
#include <xrpl/protocol/detail/permissions.macro>
38
39
#undef GRANULAR_PERMISSION
40
#pragma pop_macro("GRANULAR_PERMISSION")
41
};
42
// NOLINTEND(readability-trailing-comma)
43
44
class
Permission
45
{
46
private
:
47
Permission
();
48
49
struct
GranularPermissionEntry
50
{
51
std::string
name
;
52
TxType
txType
;
53
std::uint32_t
permittedFlags
;
54
SOTemplate
permittedFields
;
55
56
GranularPermissionEntry
(
57
std::string
name
,
58
TxType
txType
,
59
std::uint32_t
permittedFlags
,
60
std::vector<SOElement>
fields);
61
};
62
63
struct
TxDelegationEntry
64
{
65
UInt256
amendment
;
66
Delegation
delegable
{
Delegation::NotDelegable
};
67
};
68
69
std::unordered_set<TxType>
granularTxTypes_
;
70
std::unordered_map<TxType, TxDelegationEntry>
txDelegationMap_
;
71
std::unordered_map<std::string, GranularPermissionType>
granularPermissionsByName_
;
72
std::unordered_map<GranularPermissionType, GranularPermissionEntry>
granularPermissions_
;
73
74
public
:
75
static
Permission
const
&
76
getInstance
();
77
78
Permission
(
Permission
const
&) =
delete
;
79
Permission
&
80
operator=
(
Permission
const
&) =
delete
;
81
82
[[nodiscard]]
std::optional<std::string>
83
getPermissionName
(
std::uint32_t
value)
const
;
84
85
[[nodiscard]]
std::optional<std::uint32_t>
86
getGranularValue
(
std::string
const
& name)
const
;
87
88
[[nodiscard]]
std::optional<std::string>
89
getGranularName
(
GranularPermissionType
value)
const
;
90
91
[[nodiscard]]
std::optional<TxType>
92
getGranularTxType
(
GranularPermissionType
gpType)
const
;
93
94
// Returns a reference to avoid copying UInt256 - 32 bytes. std::optional
95
// cannot hold references directly, so std::reference_wrapper is used.
96
[[nodiscard]]
std::optional<std::reference_wrapper<UInt256 const>
>
97
getTxFeature
(
TxType
txType)
const
;
98
99
[[nodiscard]]
bool
100
isDelegable
(
std::uint32_t
permissionValue,
Rules
const
& rules)
const
;
101
102
[[nodiscard]]
bool
103
hasGranularPermissions
(
TxType
txType)
const
;
104
105
// for tx level permission, permission value is equal to tx type plus one
106
[[nodiscard]]
static
uint32_t
107
txToPermissionType
(
TxType
type);
108
109
// tx type value is permission value minus one
110
[[nodiscard]]
static
std::optional<TxType>
111
permissionToTxType
(
std::uint32_t
value);
112
125
[[nodiscard]]
bool
126
checkGranularSandbox
(
127
STTx
const
& tx,
128
std::unordered_set<GranularPermissionType>
const
& heldPermissions)
const
;
129
};
130
131
}
// namespace xrpl
std::string
xrpl::Permission::granularPermissionsByName_
std::unordered_map< std::string, GranularPermissionType > granularPermissionsByName_
Definition
Permissions.h:71
xrpl::Permission::Permission
Permission()
Definition
Permissions.cpp:42
xrpl::Permission::txToPermissionType
static uint32_t txToPermissionType(TxType type)
Definition
Permissions.cpp:260
xrpl::Permission::getGranularValue
std::optional< std::uint32_t > getGranularValue(std::string const &name) const
Definition
Permissions.cpp:177
xrpl::Permission::getTxFeature
std::optional< std::reference_wrapper< UInt256 const > > getTxFeature(TxType txType) const
Definition
Permissions.cpp:213
xrpl::Permission::txDelegationMap_
std::unordered_map< TxType, TxDelegationEntry > txDelegationMap_
Definition
Permissions.h:70
xrpl::Permission::getGranularTxType
std::optional< TxType > getGranularTxType(GranularPermissionType gpType) const
Definition
Permissions.cpp:197
xrpl::Permission::hasGranularPermissions
bool hasGranularPermissions(TxType txType) const
Definition
Permissions.cpp:207
xrpl::Permission::getGranularName
std::optional< std::string > getGranularName(GranularPermissionType value) const
Definition
Permissions.cpp:187
xrpl::Permission::Permission
Permission(Permission const &)=delete
xrpl::Permission::granularPermissions_
std::unordered_map< GranularPermissionType, GranularPermissionEntry > granularPermissions_
Definition
Permissions.h:72
xrpl::Permission::granularTxTypes_
std::unordered_set< TxType > granularTxTypes_
Definition
Permissions.h:69
xrpl::Permission::operator=
Permission & operator=(Permission const &)=delete
xrpl::Permission::checkGranularSandbox
bool checkGranularSandbox(STTx const &tx, std::unordered_set< GranularPermissionType > const &heldPermissions) const
Verifies a delegated transaction against its granular permission template.
Definition
Permissions.cpp:277
xrpl::Permission::permissionToTxType
static std::optional< TxType > permissionToTxType(std::uint32_t value)
Definition
Permissions.cpp:266
xrpl::Permission::isDelegable
bool isDelegable(std::uint32_t permissionValue, Rules const &rules) const
Definition
Permissions.cpp:227
xrpl::Permission::getPermissionName
std::optional< std::string > getPermissionName(std::uint32_t value) const
Definition
Permissions.cpp:157
xrpl::Permission::getInstance
static Permission const & getInstance()
Definition
Permissions.cpp:150
xrpl::Rules
Rules controlling protocol behavior.
Definition
Rules.h:40
xrpl::SOTemplate
Defines the fields and their attributes within a STObject.
Definition
SOTemplate.h:105
xrpl::STTx
Definition
STTx.h:43
cstdint
functional
std::uint32_t
xrpl
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition
algorithm.h:5
xrpl::TxType
TxType
Transaction type identifiers.
Definition
TxFormats.h:45
xrpl::GranularPermissionType
GranularPermissionType
We have both transaction type permissions and granular type permissions.
Definition
Permissions.h:31
xrpl::UInt256
BaseUInt< 256 > UInt256
Definition
base_uint.h:581
xrpl::Delegation
Delegation
Definition
TxSettings.h:11
xrpl::Delegation::NotDelegable
@ NotDelegable
Definition
TxSettings.h:11
optional
string
xrpl::Permission::GranularPermissionEntry::permittedFields
SOTemplate permittedFields
Definition
Permissions.h:54
xrpl::Permission::GranularPermissionEntry::name
std::string name
Definition
Permissions.h:51
xrpl::Permission::GranularPermissionEntry::txType
TxType txType
Definition
Permissions.h:52
xrpl::Permission::GranularPermissionEntry::permittedFlags
std::uint32_t permittedFlags
Definition
Permissions.h:53
xrpl::Permission::GranularPermissionEntry::GranularPermissionEntry
GranularPermissionEntry(std::string name, TxType txType, std::uint32_t permittedFlags, std::vector< SOElement > fields)
Definition
Permissions.cpp:30
xrpl::Permission::TxDelegationEntry
Definition
Permissions.h:64
xrpl::Permission::TxDelegationEntry::amendment
UInt256 amendment
Definition
Permissions.h:65
xrpl::Permission::TxDelegationEntry::delegable
Delegation delegable
Definition
Permissions.h:66
unordered_map
unordered_set
vector
Generated by
1.17.0