xrpld
Loading...
Searching...
No Matches
Credential.h
1// This file is auto-generated. Do not edit.
2#pragma once
3
4#include <xrpl/protocol/STLedgerEntry.h>
5#include <xrpl/protocol/STParsedJSON.h>
6#include <xrpl/protocol/jss.h>
7#include <xrpl/protocol_autogen/LedgerEntryBase.h>
8#include <xrpl/protocol_autogen/LedgerEntryBuilderBase.h>
9#include <xrpl/json/json_value.h>
10
11#include <stdexcept>
12#include <optional>
13
14namespace xrpl::ledger_entries {
15
17
28{
29public:
30 static constexpr LedgerEntryType entryType = ltCREDENTIAL;
31
37 : LedgerEntryBase(std::move(sle))
38 {
39 // Verify ledger entry type
40 if (sle_->getType() != entryType)
41 {
42 throw std::runtime_error("Invalid ledger entry type for Credential");
43 }
44 }
45
46 // Ledger entry-specific field getters
47
52 [[nodiscard]]
53 SF_ACCOUNT::type::value_type
54 getSubject() const
55 {
56 return this->sle_->at(sfSubject);
57 }
58
63 [[nodiscard]]
64 SF_ACCOUNT::type::value_type
65 getIssuer() const
66 {
67 return this->sle_->at(sfIssuer);
68 }
69
74 [[nodiscard]]
75 SF_VL::type::value_type
77 {
78 return this->sle_->at(sfCredentialType);
79 }
80
85 [[nodiscard]]
88 {
89 if (hasExpiration())
90 return this->sle_->at(sfExpiration);
91 return std::nullopt;
92 }
93
98 [[nodiscard]]
99 bool
101 {
102 return this->sle_->isFieldPresent(sfExpiration);
103 }
104
109 [[nodiscard]]
111 getURI() const
112 {
113 if (hasURI())
114 return this->sle_->at(sfURI);
115 return std::nullopt;
116 }
117
122 [[nodiscard]]
123 bool
124 hasURI() const
125 {
126 return this->sle_->isFieldPresent(sfURI);
127 }
128
133 [[nodiscard]]
134 SF_UINT64::type::value_type
136 {
137 return this->sle_->at(sfIssuerNode);
138 }
139
144 [[nodiscard]]
147 {
148 if (hasSubjectNode())
149 return this->sle_->at(sfSubjectNode);
150 return std::nullopt;
151 }
152
157 [[nodiscard]]
158 bool
160 {
161 return this->sle_->isFieldPresent(sfSubjectNode);
162 }
163
168 [[nodiscard]]
169 SF_UINT256::type::value_type
171 {
172 return this->sle_->at(sfPreviousTxnID);
173 }
174
179 [[nodiscard]]
180 SF_UINT32::type::value_type
182 {
183 return this->sle_->at(sfPreviousTxnLgrSeq);
184 }
185};
186
194class CredentialBuilder : public LedgerEntryBuilderBase<CredentialBuilder>
195{
196public:
216
223 {
224 if (sle->at(sfLedgerEntryType) != ltCREDENTIAL)
225 {
226 throw std::runtime_error("Invalid ledger entry type for Credential");
227 }
228 object_ = *sle;
229 }
230
234
241 {
242 object_[sfSubject] = value;
243 return *this;
244 }
245
252 {
253 object_[sfIssuer] = value;
254 return *this;
255 }
256
263 {
264 object_[sfCredentialType] = value;
265 return *this;
266 }
267
274 {
275 object_[sfExpiration] = value;
276 return *this;
277 }
278
285 {
286 object_[sfURI] = value;
287 return *this;
288 }
289
296 {
297 object_[sfIssuerNode] = value;
298 return *this;
299 }
300
307 {
308 object_[sfSubjectNode] = value;
309 return *this;
310 }
311
318 {
319 object_[sfPreviousTxnID] = value;
320 return *this;
321 }
322
329 {
330 object_[sfPreviousTxnLgrSeq] = value;
331 return *this;
332 }
333
340 build(uint256 const& index)
341 {
342 return Credential{std::make_shared<SLE>(std::move(object_), index)};
343 }
344};
345
346} // namespace xrpl::ledger_entries
std::shared_ptr< STLedgerEntry const > const_pointer
Builder for Credential ledger entries.
Definition Credential.h:195
CredentialBuilder & setIssuer(std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
Set sfIssuer (SoeRequired).
Definition Credential.h:251
CredentialBuilder & setIssuerNode(std::decay_t< typename SF_UINT64::type::value_type > const &value)
Set sfIssuerNode (SoeRequired).
Definition Credential.h:295
CredentialBuilder & setURI(std::decay_t< typename SF_VL::type::value_type > const &value)
Set sfURI (SoeOptional).
Definition Credential.h:284
CredentialBuilder & setPreviousTxnID(std::decay_t< typename SF_UINT256::type::value_type > const &value)
Set sfPreviousTxnID (SoeRequired).
Definition Credential.h:317
CredentialBuilder & setSubjectNode(std::decay_t< typename SF_UINT64::type::value_type > const &value)
Set sfSubjectNode (SoeOptional).
Definition Credential.h:306
CredentialBuilder(std::decay_t< typename SF_ACCOUNT::type::value_type > const &subject, std::decay_t< typename SF_ACCOUNT::type::value_type > const &issuer, std::decay_t< typename SF_VL::type::value_type > const &credentialType, std::decay_t< typename SF_UINT64::type::value_type > const &issuerNode, std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq)
Construct a new CredentialBuilder with required fields.
Definition Credential.h:206
Credential build(uint256 const &index)
Build and return the completed Credential wrapper.
Definition Credential.h:340
CredentialBuilder(SLE::const_pointer sle)
Construct a CredentialBuilder from an existing SLE object.
Definition Credential.h:222
CredentialBuilder & setCredentialType(std::decay_t< typename SF_VL::type::value_type > const &value)
Set sfCredentialType (SoeRequired).
Definition Credential.h:262
CredentialBuilder & setExpiration(std::decay_t< typename SF_UINT32::type::value_type > const &value)
Set sfExpiration (SoeOptional).
Definition Credential.h:273
CredentialBuilder & setPreviousTxnLgrSeq(std::decay_t< typename SF_UINT32::type::value_type > const &value)
Set sfPreviousTxnLgrSeq (SoeRequired).
Definition Credential.h:328
CredentialBuilder & setSubject(std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
Ledger entry-specific field setters.
Definition Credential.h:240
Ledger Entry: Credential.
Definition Credential.h:28
protocol_autogen::Optional< SF_UINT32::type::value_type > getExpiration() const
Get sfExpiration (SoeOptional).
Definition Credential.h:87
bool hasSubjectNode() const
Check if sfSubjectNode is present.
Definition Credential.h:159
SF_UINT256::type::value_type getPreviousTxnID() const
Get sfPreviousTxnID (SoeRequired).
Definition Credential.h:170
SF_ACCOUNT::type::value_type getIssuer() const
Get sfIssuer (SoeRequired).
Definition Credential.h:65
bool hasExpiration() const
Check if sfExpiration is present.
Definition Credential.h:100
static constexpr LedgerEntryType entryType
Definition Credential.h:30
SF_UINT64::type::value_type getIssuerNode() const
Get sfIssuerNode (SoeRequired).
Definition Credential.h:135
SF_VL::type::value_type getCredentialType() const
Get sfCredentialType (SoeRequired).
Definition Credential.h:76
bool hasURI() const
Check if sfURI is present.
Definition Credential.h:124
protocol_autogen::Optional< SF_VL::type::value_type > getURI() const
Get sfURI (SoeOptional).
Definition Credential.h:111
protocol_autogen::Optional< SF_UINT64::type::value_type > getSubjectNode() const
Get sfSubjectNode (SoeOptional).
Definition Credential.h:146
Credential(SLE::const_pointer sle)
Construct a Credential ledger entry wrapper from an existing SLE object.
Definition Credential.h:36
SF_ACCOUNT::type::value_type getSubject() const
Get sfSubject (SoeRequired).
Definition Credential.h:54
SF_UINT32::type::value_type getPreviousTxnLgrSeq() const
Get sfPreviousTxnLgrSeq (SoeRequired).
Definition Credential.h:181
LedgerEntryBase(SLE::const_pointer sle)
Construct a ledger entry wrapper from an existing SLE object.
SLE::const_pointer sle_
The underlying serialized ledger entry being wrapped.
T make_shared(T... args)
STL namespace.
std::conditional_t< std::is_reference_v< ValueType >, std::optional< std::reference_wrapper< std::remove_reference_t< ValueType > > >, std::optional< ValueType > > Optional
Definition Utils.h:9
LedgerEntryType
Identifiers for on-ledger objects.
BaseUInt< 256 > uint256
Definition base_uint.h:580